Skip to content

Commit

Permalink
chore: update README for v4.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
vividvilla committed Nov 23, 2021
1 parent 348e4fc commit 0507c24
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 144 deletions.
132 changes: 0 additions & 132 deletions CHANGELOG.md

This file was deleted.

22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The Kite Connect API Python client - v3
# The Kite Connect API Python client - v4

[![PyPI](https://img.shields.io/pypi/v/kiteconnect.svg)](https://pypi.python.org/pypi/kiteconnect)
[![Build Status](https://travis-ci.org/zerodhatech/pykiteconnect.svg?branch=kite3)](https://travis-ci.org/zerodhatech/pykiteconnect)
Expand All @@ -13,7 +13,7 @@ Kite Connect is a set of REST-like APIs that expose many capabilities required t

## Documentation

- [Python client documentation](https://kite.trade/docs/pykiteconnect/v3)
- [Python client documentation](https://kite.trade/docs/pykiteconnect/v4)
- [Kite Connect HTTP API documentation](https://kite.trade/docs/connect/v3)

## Installing the client
Expand Down Expand Up @@ -119,7 +119,7 @@ kite.cancel_mf_order(order_id="order_id")
kite.mf_instruments()
```

Refer to the [Python client documentation](https://kite.trade/docs/pykiteconnect/v3) for the complete list of supported methods.
Refer to the [Python client documentation](https://kite.trade/docs/pykiteconnect/v4) for the complete list of supported methods.

## WebSocket usage

Expand Down Expand Up @@ -159,32 +159,32 @@ kws.on_close = on_close
kws.connect()
```

# Run unit tests
## Run unit tests

```
```sh
python setup.py test
```

or

```
```sh
pytest -s tests/unit --cov-report html:cov_html --cov=./
```

# Run integration tests
## Run integration tests

```
```sh
pytest -s tests/integration/ --cov-report html:cov_html --cov=./ --api-key api_key --access-token access_token
```

# Generate documentation
## Generate documentation

```
```sh
pip install pdoc

pdoc --html --html-dir docs kiteconnect
```

## Changelog

[Check CHANGELOG.md](CHANGELOG.md)
[Check Release notes](https://github.com/zerodha/pykiteconnect/releases)
2 changes: 1 addition & 1 deletion kiteconnect/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
__description__ = "The official Python client for the Kite Connect trading API"
__url__ = "https://kite.trade"
__download_url__ = "https://github.com/zerodhatech/pykiteconnect"
__version__ = "3.9.5"
__version__ = "4.0.0"
__author__ = "Zerodha Technology Pvt. Ltd. (India)"
__author_email__ = "talk@zerodha.tech"
__license__ = "MIT"

0 comments on commit 0507c24

Please sign in to comment.