Skip to main content

Changelog

1.6.4​

Added​
  • added monthlyUsage() and limits() methods to UserClient

1.6.3​

Added​
  • added log() method to BuildClient (see API reference for more context)

1.6.2​

Internal changes​
  • Relative imports were replaced with absolute imports

1.6.1​

Fixed​
  • Fixed _BaseHTTPClient._parse_params() method to ensure correct conversion of API list parameters

1.6.0​

Internal changes​
  • Migrate from Autopep8 and Flake8 to Ruff

1.5.0​

Added​
  • added support for Python 3.12
  • added DELETE to Actor runs
  • added DELETE to Actor builds
Internal changes​
  • rewrote documentation publication to use Docusaurus
  • removed PR Toolkit workflow

1.4.1​

Added​
  • added StoreCollectionClient for listing Actors in the Apify Store
  • added support for specifying the max_items parameter for pay-per result Actors and their runs
Internal changes​
  • improved logging of HTTP requests
  • removed pytest-randomly Pytest plugin

1.4.0​

  • added RunClient.reboot method to reboot Actor runs
Internal changes​
  • simplified code via flake8-simplify
  • unified indentation in configuration files

1.3.1​

Internal changes​
  • started importing general constants and utilities from the apify-shared library

1.3.0​

Added​
  • added list_and_lock_head, delete_request_lock, prolong_request_lock methods to RequestQueueClient
  • added batch_add_requests, batch_delete_requests, list_requests methods RequestQueueClient

1.2.2​

Fixed​
  • fixed encoding webhook lists in request parameters

1.2.1​

Fixed​
  • relaxed dependency requirements to improve compatibility with other libraries

1.2.0​

Added​
  • added option to change the build, memory limit and timeout when resurrecting a run
Internal changes​
  • updated dependencies

1.1.1​

Internal changes​
  • changed GitHub workflows to use new secrets

1.1.0​

Added​
  • added support for is_status_message_terminal flag in Actor run status message update
Internal changes​
  • switched from setup.py to pyproject.toml for specifying project setup

1.0.0​

Breaking changes​
  • dropped support for Python 3.7, added support for Python 3.11
  • unified methods for streaming resources
  • switched underlying HTTP library from requests to httpx
Added​
  • added support for asynchronous usage via ApifyClientAsync
  • added configurable socket timeout for requests to the Apify API
  • added py.typed file to signal type checkers that this package is typed
  • added method to update status message for a run
  • added option to set up webhooks for actor builds
  • added logger with basic debugging info
  • added support for schema parameter in get_or_create method for datasets and key-value stores
  • added support for title parameter in task and schedule methods
  • added x-apify-workflow-key header support
  • added support for flatten and view parameters in dataset items methods
  • added support for origin parameter in actor/task run methods
  • added clients for actor version environment variables
Fixed​
  • disallowed NaN and Infinity values in JSONs sent to the Apify API
Internal changes​
  • simplified retrying with exponential backoff
  • improved checks for "not found" errors
  • simplified flake8 config
  • updated development dependencies
  • simplified development scripts
  • updated GitHub Actions versions to fix deprecations
  • unified unit test style
  • unified preparing resource representation
  • updated output management in GitHub Workflows to fix deprecations
  • improved type hints across codebase
  • added option to manually publish the package with a workflow dispatch
  • added pre-commit to run code quality checks before committing
  • converted unittest-style tests to pytest-style tests
  • backported project setup improvements from apify-sdk-python

0.6.0​

Removed​
  • Dropped support for single-file actors
Internal changes​
  • updated dependencies
  • fixed some lint issues in shell scripts and setup.py
  • added Python 3.10 to unit test roster

0.5.0​

Changed​
  • improved retrying broken API server connections
Fixed​
  • fixed timeout value in actively waiting for a run to finish
Internal changes​
  • updated development dependencies

0.4.0​

Changed​
  • improved handling of Enum arguments
  • improved support for storing more data types in key-value stores
Fixed​
  • fixed values of some ActorJobStatus Enum members

0.3.0​

Added​
  • added the test() method to the webhook client
  • added support for indicating the pagination direction in the ListPage objects
Changed​
  • improved support for storing more data types in datasets
Fixed​
  • fixed return type in the DatasetClient.list_items() method docs
Internal changes​
  • added human-friendly names to the jobs in Github Action workflows
  • updated development dependencies

0.2.0​

Added​
  • added the gracefully parameter to the "Abort run" method
Changed​
  • replaced base_url with api_url in the client constructor to enable easier passing of the API server url from environment variables available to actors on the Apify platform
Internal changes​
  • changed tags for actor images with this client on Docker Hub to be aligned with the Apify SDK Node.js images
  • updated the requests dependency to 2.26.0
  • updated development dependencies

0.1.0​

Changed​
  • methods using specific option values for arguments now use well-defined and documented Enums for those arguments instead of generic strings
  • made the submodule apify_client.consts containing the aforementioned Enums available
Internal changes​
  • updated development dependencies
  • enforced unified use of single quotes and double quotes
  • added repository dispatch to build actor images with this client when publishing a new version

0.0.1​

Initial release of the package.