1
1
# Apify API client for Python
2
2
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.
5
8
6
9
## Installation
7
10
8
11
Requires Python 3.8+
9
12
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 ) .
11
14
To do that, simply run ` pip install apify-client ` in your terminal.
12
15
13
16
## Usage
14
17
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 ) .
16
19
17
20
## Development
18
21
@@ -21,7 +24,7 @@ For usage instructions, check the documentation on [Apify Docs](https://docs.api
21
24
For local development, it is required to have Python 3.8 installed.
22
25
23
26
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,
25
28
this is left up to the developers to do themselves.
26
29
27
30
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`
42
45
43
46
We use ` autopep8 ` and ` isort ` to automatically format the code to a common format. To run the formatting, just run ` make format ` .
44
47
45
- ### Linting and Testing
48
+ ### Linting, type-checking and unit testing
46
49
47
50
We use ` flake8 ` for linting, ` mypy ` for type checking and ` pytest ` for unit testing. To run these tools, just run ` make check-code ` .
48
51
0 commit comments