Skip to main content

Changelog

All notable changes to this project will be documented in this file.

1.12.3 - not yet released​

🚀 Features​

1.12.2 (2025-08-08)​

🐛 Bug Fixes​

1.12.1 (2025-07-30)​

🐛 Bug Fixes​

1.12.0 (2025-06-26)​

🚀 Features​

🐛 Bug Fixes​

1.11.0 (2025-06-13)​

🚀 Features​

1.10.0 (2025-04-29)​

🚀 Features​

1.9.4 (2025-04-24)​

🐛 Bug Fixes​

1.9.3 (2025-04-14)​

🚀 Features​

1.9.2 (2025-02-14)​

🐛 Bug Fixes​

1.9.1 (2025-02-07)​

🐛 Bug Fixes​

1.9.0 (2025-02-04)​

🚀 Features​

1.8.1 (2024-09-17)​

🐛 Bug Fixes​

1.8.0 (2024-08-30)​

  • drop support for Python 3.8

🚀 Features​

1.7.1 (2024-07-11)​

🐛 Bug Fixes​

  • Fix breaking change (sync -> async) in 1.7.0
  • Fix getting storages of last run

1.7.0 (2024-05-20)​

🐛 Bug Fixes​

  • Fix abort of last task run
  • Fix abort of last Actor run
  • ActorClient's and TaskClient's last_run methods are asynchronous

1.6.4 (2024-02-27)​

🚀 Features​

  • Add monthlyUsage() and limits() methods to UserClient

1.6.3 (2023-02-16)​

🚀 Features​

  • Add log() method to BuildClient

1.6.2 (2023-01-08)​

Chore​

  • Relative imports were replaced for absolute imports

1.6.1 (2023-12-11)​

🐛 Bug Fixes​

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

1.6.0 (2023-11-16)​

Chore​

  • Migrate from Autopep8 and Flake8 to Ruff

1.5.0 (2023-10-18)​

🚀 Features​

  • Add support for Python 3.12
  • Add DELETE to Actor runs
  • Add DELETE to Actor builds

Chore​

  • Rewrite documentation publication to use Docusaurus
  • Remove PR Toolkit workflow

1.4.1 (2023-09-06)​

🚀 Features​

  • Add StoreCollectionClient for listing Actors in the Apify Store
  • Add support for specifying the max_items parameter for pay-per result Actors and their runs

Chore​

  • Improve logging of HTTP requests
  • Remove pytest-randomly Pytest plugin

1.4.0 (2023-08-23)​

🚀 Features​

  • Add RunClient.reboot method to reboot Actor runs

Chore​

  • Simplify code via flake8-simplify
  • Unify indentation in configuration files

1.3.1 (2023-07-28)​

Chore​

  • Start importing general constants and utilities from the apify-shared library

1.3.0 (2023-07-24)​

🚀 Features​

  • Add list_and_lock_head, delete_request_lock, prolong_request_lock methods to RequestQueueClient
  • Add batch_add_requests, batch_delete_requests, list_requests methods RequestQueueClient

1.2.2 (2023-05-31)​

🐛 Bug Fixes​

  • Fix encoding webhook lists in request parameters

1.2.1 (2023-05-23)​

🐛 Bug Fixes​

  • Relax dependency requirements to improve compatibility with other libraries

1.2.0 (2023-05-23)​

🚀 Features​

  • Add option to change the build, memory limit and timeout when resurrecting a run

Chore​

  • Update dependencies

1.1.1 (2023-05-05)​

Chore​

  • Change GitHub workflows to use new secrets

1.1.0 (2023-05-05)​

🚀 Features​

  • Add support for is_status_message_terminal flag in Actor run status message update

Chore​

  • Switch from setup.py to pyproject.toml for specifying project setup

1.0.0 (2023-03-13)​

Breaking changes​

  • Drop support for Python 3.7, add support for Python 3.11
  • Unify methods for streaming resources
  • Switch underlying HTTP library from requests to httpx

🚀 Features​

  • Add support for asynchronous usage via ApifyClientAsync
  • Add configurable socket timeout for requests to the Apify API
  • Add py.typed file to signal type checkers that this package is typed
  • Add method to update status message for a run
  • Add option to set up webhooks for Actor builds
  • Add logger with basic debugging info
  • Add support for schema parameter in get_or_create method for datasets and key-value stores
  • Add support for title parameter in task and schedule methods
  • Add x-apify-workflow-key header support
  • Add support for flatten and view parameters in dataset items methods
  • Add support for origin parameter in Actor/task run methods
  • Add clients for Actor version environment variables

🐛 Bug Fixes​

  • Disallow NaN and Infinity values in JSONs sent to the Apify API

Chore​

  • Simplify retrying with exponential backoff
  • Improve checks for "not found" errors
  • Simplify flake8 config
  • Update development dependencies
  • Simplify development scripts
  • Update GitHub Actions versions to fix deprecations
  • Unify unit test style
  • Unify preparing resource representation
  • Update output management in GitHub Workflows to fix deprecations
  • Improve type hints across codebase
  • Add option to manually publish the package with a workflow dispatch
  • Add pre-commit to run code quality checks before committing
  • Convert unittest-style tests to pytest-style tests
  • Backport project setup improvements from apify-sdk-python

0.6.0 (2022-06-27)​

Removed​

  • Drop support for single-file Actors

Chore​

  • Update dependencies
  • Fix some lint issues in shell scripts and setup.py
  • Add Python 3.10 to unit test roster

0.5.0 (2021-09-16)​

Changed​

  • Improve retrying broken API server connections

🐛 Bug Fixes​

  • Fix timeout value in actively waiting for a run to finish

Chore​

  • Update development dependencies

0.4.0 (2021-09-07)​

Changed​

  • Improve handling of Enum arguments
  • Improve support for storing more data types in key-value stores

🐛 Bug Fixes​

  • Fix values of some ActorJobStatus Enum members

0.3.0 (2021-08-26)​

🚀 Features​

  • Add the test() method to the webhook client
  • Add support for indicating the pagination direction in the ListPage objects

Changed​

  • Improve support for storing more data types in datasets

🐛 Bug Fixes​

  • Fix return type in the DatasetClient.list_items() method docs

Chore​

  • Add human-friendly names to the jobs in Github Action workflows
  • Update development dependencies

0.2.0 (2021-08-09)​

🚀 Features​

  • Add the gracefully parameter to the "Abort run" method

Changed​

  • Replace 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

Chore​

  • Change tags for Actor images with this client on Docker Hub to be aligned with the Apify SDK Node.js images
  • Update the requests dependency to 2.26.0
  • Update development dependencies

0.1.0 (2021-08-02)​

Changed​

  • Methods using specific option values for arguments now use well-defined and documented Enums for those arguments instead of generic strings
  • Make the submodule apify_client.consts containing those Enums available

Chore​

  • Update development dependencies
  • Enforce unified use of single quotes and double quotes
  • Add repository dispatch to build Actor images with this client when publishing a new version

0.0.1 (2021-05-13)​

  • Initial release of the package.