Movatterモバイル変換

algolia/algoliasearch-client-pythonPublic

NotificationsYou must be signed in to change notification settings
Fork63
Star206

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

www.algolia.com/doc/libraries/sdk/install#python

License

MIT license

206 stars 63 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,055 Commits
.github		.github
algoliasearch		algoliasearch
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt
setup.cfg		setup.cfg
setup.py		setup.py

Repository files navigation

The perfect starting point to integrateAlgolia within your Python project

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 from3.8

💡 Getting Started

First, install Algolia Python API Client via thepip 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.

fromalgoliasearch.search.clientimportSearchClient_client=SearchClient("YOUR_APP_ID","YOUR_API_KEY")# Add a new record to your Algolia indexresponse=await_client.save_object(index_name="<YOUR_INDEX_NAME>",body={"objectID":"id","test":"val",    },)# use the class directlyprint(response)# print the JSON responseprint(response.to_json())# Poll the task status to know when it has been indexedawaitclient.wait_for_task(index_name="<YOUR_INDEX_NAME>",task_id=response.task_id)# Fetch search results, with typo toleranceresponse=await_client.search(search_method_params={"requests": [            {"indexName":"<YOUR_INDEX_NAME>","query":"<YOUR_QUERY>","hitsPerPage":50,            },        ],    },)# use the class directlyprint(response)# print the JSON responseprint(response.to_json())

For full documentation, visit theAlgolia Python API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to ourFAQ where you will find answers for the most common issues and gotchas with the client. You can also opena 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 themain repository. You can also find contributing guides onour documentation website.