A fully-featured and blazing-fast Python API client to interact with Algolia.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for algolia from gravatar.com algolia Avatar for kai687 from gravatar.com kai687 Avatar for shortcuts from gravatar.com shortcuts

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Algolia Team
  • Tags algolia , search , full-text-search , neural-search
  • Requires: Python >=3.8.1
Classifiers
Report project as malware

Project description

Algolia for Python

The perfect starting point to integrate Algolia within your Python project

PyPI Python versions License

Documentation • Django • Community Forum • Stack Overflow • Report a bug • Support

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Supports Python from 3.8

💡 Getting Started

First, install Algolia Python API Client via the pip package manager:

pip install --upgrade 'algoliasearch>=4.0,<5.0'

You can now import the Algolia API client in your project and play with it.

from algoliasearch.search.client import SearchClient

_client = SearchClient("YOUR_APP_ID", "YOUR_API_KEY")

# Add a new record to your Algolia index
response = await _client.save_object(
    index_name="<YOUR_INDEX_NAME>",
    body={
        "objectID": "id",
        "test": "val",
    },
)

# use the class directly
print(response)

# print the JSON response
print(response.to_json())

# Poll the task status to know when it has been indexed
await client.wait_for_task(index_name="<YOUR_INDEX_NAME>", task_id=response.task_id)

# Fetch search results, with typo tolerance
response = await _client.search(
    search_method_params={
        "requests": [
            {
                "indexName": "<YOUR_INDEX_NAME>",
                "query": "<YOUR_QUERY>",
                "hitsPerPage": 50,
            },
        ],
    },
)

# use the class directly
print(response)

# print the JSON response
print(response.to_json())

For full documentation, visit the Algolia Python API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue

Contributing

This repository hosts the code of the generated Algolia API client for Python, if you'd like to contribute, head over to the main repository. You can also find contributing guides on our documentation website.

📄 License

The Algolia Python API Client is an open-sourced software licensed under the MIT license.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for algolia from gravatar.com algolia Avatar for kai687 from gravatar.com kai687 Avatar for shortcuts from gravatar.com shortcuts

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Algolia Team
  • Tags algolia , search , full-text-search , neural-search
  • Requires: Python >=3.8.1
Classifiers

Release history Release notifications | RSS feed

This version

4.44.3

4.44.1

4.44.0

4.43.0

4.42.0

4.41.1

4.40.1

4.40.0

4.39.0

4.38.1

4.38.0

4.37.1

4.37.0

4.36.1

4.36.0

4.35.4

4.35.3

4.35.2

4.35.0

4.34.0

4.33.0

4.32.0

4.31.0

4.30.0

4.29.0

4.28.0

4.27.0

4.26.0

4.25.0

4.24.0

4.23.1

4.23.0

4.22.1

4.22.0

4.21.0

4.20.0

4.19.0

4.18.0

4.17.0

4.16.5

4.16.4

4.16.3

4.16.2

4.16.1

4.16.0

4.15.0

4.14.0

4.13.3

4.13.2

4.13.1

4.13.0

4.12.0

4.11.2

4.11.1

4.11.0

4.10.0

4.9.2

4.9.1

4.9.0

4.8.1

4.8.0

4.7.0

4.6.5

4.6.4

4.6.3

4.6.2

4.6.1

4.6.0

4.5.0

4.4.6

4.4.5

4.4.4

4.4.3

4.4.2

4.4.1

4.4.0

4.3.0

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.1

4.1.0

4.0.2

4.0.0

4.0.0b31 pre-release

4.0.0b30 pre-release

4.0.0b29 pre-release

4.0.0b28 pre-release

4.0.0b27 pre-release

4.0.0b26 pre-release

4.0.0b25 pre-release

4.0.0b24 pre-release

4.0.0b23 pre-release

4.0.0b22 pre-release

4.0.0b21 pre-release

4.0.0b20 pre-release

4.0.0b19 pre-release

4.0.0b17 pre-release

4.0.0b16 pre-release

4.0.0b15 pre-release

4.0.0b14 pre-release

4.0.0b13 pre-release

4.0.0b12 pre-release

4.0.0b11 pre-release

4.0.0b10 pre-release

4.0.0b9 pre-release

4.0.0b8 pre-release

4.0.0b7 pre-release

4.0.0b6 pre-release

4.0.0b5 pre-release

4.0.0b4 pre-release

4.0.0b3 pre-release

4.0.0b2 pre-release

4.0.0b1 pre-release

4.0.0a7 pre-release

4.0.0a6 pre-release

4.0.0a5 pre-release

4.0.0a4 pre-release

3.0.0

2.6.3

2.6.2

2.6.1

2.6.0

2.5.0

2.4.0

2.3.1

2.3.0

2.2.0

2.1.0

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

2.0.0b5 pre-release

2.0.0b4 pre-release

2.0.0b3 pre-release

2.0.0b2 pre-release

2.0.0b1 pre-release

1.20.0

1.19.1

1.19.0

1.18.1

1.18.0

1.17.0

1.16.0

1.15.3

1.15.2

1.15.0

1.14.1

1.14.0

1.13.0

1.12.0

1.11.3

1.11.2

1.11.0

1.10.0

1.9.2

1.9.1

1.9.0

1.8.0

1.7.1

1.7.0

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.5.9

1.5.8

1.5.7

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.0

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.2

1.0.1

1.0.0

Download files

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

Source Distribution

algoliasearch-4.44.3.tar.gz (460.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

algoliasearch-4.44.3-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file algoliasearch-4.44.3.tar.gz.

File metadata

  • Download URL: algoliasearch-4.44.3.tar.gz
  • Upload date:
  • Size: 460.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for algoliasearch-4.44.3.tar.gz
Algorithm Hash digest
SHA256 1c5e3b72912ef162bc0e772c84767e7db48f5549e375d88930aed8b78a1db3b3
MD5 98847fc0fe8776d9d155f7ad032892a4
BLAKE2b-256 aee3d92bebdd9794cc00ad72b333d39354ea1ab5b7d5cde2ea69f4a3265212fb

See more details on using hashes here.

Provenance

The following attestation bundles were made for algoliasearch-4.44.3.tar.gz:

Publisher: release.yml on algolia/algoliasearch-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file algoliasearch-4.44.3-py3-none-any.whl.

File metadata

  • Download URL: algoliasearch-4.44.3-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for algoliasearch-4.44.3-py3-none-any.whl
Algorithm Hash digest
SHA256 6326db9d102e0c43712c04334bb9a9e8bd980c7bc1a471cb75b320f4d606953d
MD5 2d57add8fb12e774bfdcdc31caa598a9
BLAKE2b-256 320584c46d0844055735c1192ba1a0364d871251dbf03e26a465eedf148e63f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for algoliasearch-4.44.3-py3-none-any.whl:

Publisher: release.yml on algolia/algoliasearch-client-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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