Apify API client for Python
Apify API client for Python
This is an official client for the Apify API. It's still a work in progress, so please don't use it yet in production environments!
Requires Python 3.7+
You can install the client from its PyPI listing.
To do that, simply run
pip install apify-client in your terminal.
For local development, it is required to have Python 3.7 installed.
It is recommended to set up a virtual environment while developing this package to isolate your development environment, however, due to the many varied ways Python can be installed and virtual environments can be set up, this is left up to the developers to do themselves.
One recommended way is with the builtin
python3 -m venv .venv source .venv/bin/activate
To improve on the experience, you can use pyenv to have an environment with a pinned Python version, and direnv to automatically activate/deactivate the environment when you enter/exit the project folder.
To install this package and its development dependencies, run
pip install -e '.[dev]'
isort to automatically format the code to a common format. To run the formatting, just run
Linting and Testing
flake8 for linting,
mypy for type checking and
pytest for unit testing. To run these tools, just run
We use the Google docstring format for documenting the code. We document every user-facing class or method, and enforce that using the flake8-docstrings library.
The documentation is then rendered from the docstrings in the code using Sphinx and some heavy post-processing and saved as
To generate the documentation, just run
Publishing new versions to PyPI happens automatically through GitHub Actions.
On each commit to the
master branch, a new beta release is published, taking the version number from
and automatically incrementing the beta version suffix by 1 from the last beta release published to PyPI.
A stable version is published when a new release is created using GitHub Releases, again taking the version number from
src/apify_client/_version.py. The built package assets are automatically uploaded to the GitHub release.
If there is already a stable version with the same version number as in
src/apify_client/_version.py published to PyPI, the publish process fails,
so don't forget to update the version number before releasing a new version.
The release process also fails when the released version is not described in
so don't forget to describe the changes in the new version there.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size apify_client-0.0.1-1-py3-none-any.whl (54.8 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size apify_client-0.0.1-1.tar.gz (32.7 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for apify_client-0.0.1-1-py3-none-any.whl