Skip to content

Commit 984bb5f

Browse files
committed
Touch up Readme
1 parent 8c97c33 commit 984bb5f

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
# Apify API client for Python
22

3-
This is an official client for the [Apify API](https://www.apify.com/docs/api/v2).
4-
It's still a work in progress, so please don't use it yet in production environments!
3+
The Apify API Client for Python is the official library to access the [Apify API](https://docs.apify.com/api/v2) from your Python applications.
4+
It provides useful features like automatic retries and convenience functions to improve your experience with the Apify API.
5+
6+
If you want to develop Apify Actors in Python,
7+
check out the [Apify SDK for Python](https://docs.apify.com/sdk/python) instead.
58

69
## Installation
710

811
Requires Python 3.8+
912

10-
You can install the client from its [PyPI listing](https://pypi.org/project/apify-client).
13+
You can install the package from its [PyPI listing](https://pypi.org/project/apify-client).
1114
To do that, simply run `pip install apify-client` in your terminal.
1215

1316
## Usage
1417

15-
For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/apify-client-python) or in [`docs/docs.md`](docs/docs.md).
18+
For usage instructions, check the documentation on [Apify Docs](https://docs.apify.com/api/client/python/) or in [`docs/docs.md`](docs/docs.md).
1619

1720
## Development
1821

@@ -21,7 +24,7 @@ For usage instructions, check the documentation on [Apify Docs](https://docs.api
2124
For local development, it is required to have Python 3.8 installed.
2225

2326
It is recommended to set up a virtual environment while developing this package to isolate your development environment,
24-
however, due to the many varied ways Python can be installed, and virtual environments can be set up,
27+
however, due to the many varied ways Python can be installed and virtual environments can be set up,
2528
this is left up to the developers to do themselves.
2629

2730
One recommended way is with the built-in `venv` module:
@@ -42,7 +45,7 @@ To install this package and its development dependencies, run `make install-dev`
4245

4346
We use `autopep8` and `isort` to automatically format the code to a common format. To run the formatting, just run `make format`.
4447

45-
### Linting and Testing
48+
### Linting, type-checking and unit testing
4649

4750
We use `flake8` for linting, `mypy` for type checking and `pytest` for unit testing. To run these tools, just run `make check-code`.
4851

0 commit comments

Comments
 (0)