Skip to main content

Python interface to Zyte API

Project description

PyPI Version Supported Python Versions Build Status Coverage report

Python client libraries for Zyte API.

Command-line utility and asyncio-based library are provided by this package.

Installation

pip install zyte-api

zyte-api requires Python 3.7+.

API key

Make sure you have an API key for the Zyte API service. You can set ZYTE_API_KEY environment variable with the key to avoid passing it around explicitly.

Read the documentation for more information.

License is BSD 3-clause.

Changes

0.4.6 (2023-09-26)

  • Increased the client timeout to match the server’s.

  • Mentioned the api_key parameter of AsyncClient in the docs example.

0.4.5 (2023-01-03)

  • w3lib >= 2.1.1 is required in install_requires, to ensure that URLs are escaped properly.

  • unnecessary requests library is removed from install_requires

  • fixed tox 4 support

0.4.4 (2022-12-01)

  • Fixed an issue with submitting URLs which contain unescaped symbols

  • New “retrying” argument for AsyncClient.__init__, which allows to set custom retrying policy for the client

  • --dont-retry-errors argument in the CLI tool

0.4.3 (2022-11-10)

  • Connections are no longer reused between requests. This reduces the amount of ServerDisconnectedError exceptions.

0.4.2 (2022-10-28)

  • Bump minimum aiohttp version to 3.8.0, as earlier versions don’t support brotli decompression of responses

  • Declared Python 3.11 support

0.4.1 (2022-10-16)

  • Network errors, like server timeouts or disconnections, are now retried for up to 15 minutes, instead of 5 minutes.

0.4.0 (2022-09-20)

  • Require to install Brotli as a dependency. This changes the requests to have Accept-Encoding: br and automatically decompress brotli responses.

0.3.0 (2022-07-29)

Internal AggStats class is cleaned up:

  • AggStats.n_extracted_queries attribute is removed, as it was a duplicate of AggStats.n_results

  • AggStats.n_results is renamed to AggStats.n_success

  • AggStats.n_input_queries is removed as redundant and misleading; AggStats got a new AggStats.n_processed property instead.

This change is backwards incompatible if you used stats directly.

0.2.1 (2022-07-29)

  • aiohttp.client_exceptions.ClientConnectorError is now treated as a network error and retried accordingly.

  • Removed the unused zyte_api.sync module.

0.2.0 (2022-07-14)

  • Temporary download errors are now retried 3 times by default. They were not retried in previous releases.

0.1.4 (2022-05-21)

This release contains usability improvements to the command-line script:

  • Instead of python -m zyte_api you can now run it as zyte-api;

  • the type of the input file (--intype argument) is guessed now, based on file extension and content; .jl, .jsonl and .txt files are supported.

0.1.3 (2022-02-03)

  • Minor documenation fix

  • Remove support for Python 3.6

  • Added support for Python 3.10

0.1.2 (2021-11-10)

  • Default timeouts changed

0.1.1 (2021-11-01)

  • CHANGES.rst updated properly

0.1.0 (2021-11-01)

  • Initial release.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zyte-api-0.4.6.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

zyte_api-0.4.6-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

Details for the file zyte-api-0.4.6.tar.gz.

File metadata

  • Download URL: zyte-api-0.4.6.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for zyte-api-0.4.6.tar.gz
Algorithm Hash digest
SHA256 f27ca7c37e831e1d3ee9a1e8fb4f0dff22abbdfa0342de3fb8303d999e765e7a
MD5 465aa1d1a996962813776f003ec9a8b1
BLAKE2b-256 07ebe4aefdd85b6a1c0a41b4a32892a8b84ed1126aaf2eec95a67410296ef84c

See more details on using hashes here.

File details

Details for the file zyte_api-0.4.6-py3-none-any.whl.

File metadata

  • Download URL: zyte_api-0.4.6-py3-none-any.whl
  • Upload date:
  • Size: 14.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for zyte_api-0.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 74f2b8d4beea0a9893cf496a1b4864609782fa6e73c4c6f8be222833ef37ce04
MD5 b6344ef93643b4841457bb07c56fe7bd
BLAKE2b-256 6722ae3712c2ba08b71ec6a0a97b9d84cdf61c75535fe14fa853dc20c55ac5a8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page