Skip to main content

Python Push API Client

Project description

Python Push API Client

Installation

pip install coveo-push-api-client.py

Usage

See more examples in the ./samples folder.

from push_api_clientpy import Source, DocumentBuilder

source = Source("my_api_key", "my_org_id")

myDocument = DocumentBuilder("https://my.document.uri", "My document title")\
   .withData("these words will be searchable")

response = source.addOrUpdateDocument("my_source_id", myDocument)

print(f"Document added: {response.json()}")

Exponential backoff retry configuration

By default, the SDK leverages an exponential backoff retry mechanism. Exponential backoff allows for the SDK to make multiple attempts to resolve throttled requests, increasing the amount of time to wait for each subsequent attempt. Outgoing requests will retry when a 429 status code is returned from the platform.

The exponential backoff parameters are as follows:

  • retry_after - The amount of time, in seconds, to wait between throttled request attempts.

    Optional, will default to 5.

  • max_retries - The maximum number of times to retry throttled requests.

    Optional, will default to 10.

You may configure the exponential backoff that will be applied to all outgoing requests. To do so, specify a BackoffOptions object when creating either a Source or PlatformClient object:

source = Source("my_api_key", "my_org_id", BackoffOptions(3, 10))

By default, requests will retry a maximum of 10 times, waiting 10 seconds after the second attempt, with a time multiple of 2 (which will equate to a maximum execution time of roughly 1.5 hours. See urllib3 Retry documentation).

Dev

  • Requires Python 3.9

  • Requires pipenv: pip install pipenv

  • Install dependencies: pipenv install --dev

  • Build: pipenv run tox -e build

  • Tests: pipenv run tox

  • Full list of commands: pipenv run tox -av

Versioning and Publishing to PyPI

Before merging a feature branch into master, you must update the package version of your branch:

  • Open pyproject.toml in the text editor of your choice

  • Under [project], update the version, following semantic versioning format (v{Major}.{Minor}.{Patch})

Once the feature branch you would like to publish has been merged into master:

  • Checkout the latest version of master on local

  • Run pipenv run tox -e clean

  • Run pipenv run tox -e build

You should now see that that the dist directory has been populated with a .whl and .tar.gz file with the correct version in the filenames. These are the distribution archives.

Once the distribution archives are ready:

  • Run pipenv run tox -e publish -- --repository pypi from the root directory

  • When prompted for a username, enter __token__

  • When prompted for a password, enter the PyPI publishing API key, including the pypi- prefix

After the command finishes running with a successful exit message, confirm that the published version is live on PyPI.

Note

This project has been set up using PyScaffold 4.0.1. For details and usage information on PyScaffold see https://pyscaffold.org/.

For more information on the release process, refer to the PyPi and PyScaffold documentation.

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

coveo-push-api-client.py-1.1.2.tar.gz (29.2 kB view details)

Uploaded Source

Built Distribution

coveo_push_api_client.py-1.1.2-py2.py3-none-any.whl (10.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file coveo-push-api-client.py-1.1.2.tar.gz.

File metadata

File hashes

Hashes for coveo-push-api-client.py-1.1.2.tar.gz
Algorithm Hash digest
SHA256 6efae67e7e01091e7b0744ceda6cefbfc01a686a2560a0d46240d5146da788c3
MD5 bc540c43073fd6c0ce9e641498a5cdd1
BLAKE2b-256 6f38de194403e08f9a777b7a5a6f057be1ad4b2b7280c5d81a82f813db491ea2

See more details on using hashes here.

File details

Details for the file coveo_push_api_client.py-1.1.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for coveo_push_api_client.py-1.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 00229bbba88d06bf057e95e28b8e082e48397ff2ccdc4d5ddc0ae8b90dd20bdc
MD5 2744e2c4809c1e187d46cea556209701
BLAKE2b-256 6cb9bc402f020f543354b1c8b95e4760e595e53dbd44665ad6606715351733e0

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