{
"info": {
"author": "R\u00e9my Hubscher",
"author_email": "hubscher.remy@gmail.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 2 - Pre-Alpha",
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Natural Language :: English",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6"
],
"description": "Kinto Algolia\n#############\n\n.. image:: https://img.shields.io/travis/Kinto/kinto-algolia.svg\n :target: https://travis-ci.org/Kinto/kinto-algolia\n\n.. image:: https://img.shields.io/pypi/v/kinto-algolia.svg\n :target: https://pypi.python.org/pypi/kinto-algolia\n\n.. image:: https://coveralls.io/repos/Kinto/kinto-algolia/badge.svg?branch=master\n :target: https://coveralls.io/r/Kinto/kinto-algolia\n\n**kinto-algolia** forwards the records to Algolia and provides a ``/search``\nendpoint to query the indexed data.\n\n\nInstall\n=======\n\n::\n\n pip install kinto-algolia\n\n\nSetup\n=====\n\nIn the `Kinto `_ settings:\n\n.. code-block :: ini\n\n kinto.includes = kinto_algolia\n kinto.algolia.application_id = YourApplicationID\n kinto.algolia.api_key = YourAPIKey\n\n # List of buckets/collections to show:\n kinto.algolia.resources = /buckets/chefclub-v2\n /buckets/chefclub/collections/recipes\n\nBy default, indices names are prefixed with ``kinto-``. You change this with:\n\n.. code-block :: ini\n\n kinto.algolia.index_prefix = myprefix\n\n\nUsage\n=====\n\nCreate a new record:\n\n::\n\n $ echo '{\"data\":\n {\"id\": \"1008855320\",\n \"last_modified\": 1523349594783,\n \"title\": \"kinto\",\n \"description\": \"A database for the web\",\n \"_geoloc\": {\"lng\": -73.778925, \"lat\": 40.639751}}' | \\\n http POST http://localhost:8888/v1/buckets/example/collections/notes/records \\\n --auth token:alice-token\n\n\nIt should now be possible to search for it using the `Algolia API `_.\n\nFor example, using a quick querystring search:\n\n::\n\n $ http \"http://localhost:8888/v1/buckets/example/collections/notes/search?query=kinto+database\" \\\n --auth token:alice-token\n\n\nOr an advanced search using request body:\n\n::\n\n $ echo '{\"insideBoundingBox\": \"46.650828100116044,7.123046875,45.17210966999772,1.009765625\"}' | \\\n http POST http://localhost:8888/v1/buckets/example/collections/notes/search \\\n --auth token:alice-token\n\n.. code-block:: http\n\n HTTP/1.1 200 OK\n Access-Control-Expose-Headers: Retry-After, Content-Length, Alert, Backoff\n Content-Length: 333\n Content-Type: application/json; charset=UTF-8\n Date: Wed, 20 Jan 2016 12:02:05 GMT\n Server: waitress\n\n {\n \"hits\": [\n {\n \"_geoloc\": {\n \"lat\": 40.639751,\n \"lng\": -73.778925\n },\n \"_highlightResult\": {\n \"title\": {\n \"matchLevel\": \"none\",\n \"matchedWords\": [],\n \"value\": \"Kinto\"\n }\n },\n \"last_modified\": 1523349594783,\n \"title\": \"Kinto\",\n \"description\": \"A database for the web\",\n \"objectID\": \"1008855320\"\n }\n ],\n \"hitsPerPage\": 1000,\n \"nbHits\": 1,\n \"nbPages\": 1,\n \"page\": 0,\n \"params\": \"insideBoundingBox=42.124710287101955%2C9.335632324218752%2C41.47360232634395%2C14.403076171875002&hitsPerPage=10000&query=\",\n \"processingTimeMS\": 2,\n \"query\": \"\"\n }\n\n\nCustom index settings\n---------------------\n\nBy default, Algolia infers the data types from the indexed records.\n\nBut it's possible to define the index mappings (ie. schema) from the collection metadata,\nin the ``algolia:settings`` property:\n\n.. code-block:: bash\n\n $ echo '{\n \"attributesToIndex\": [\"title\", \"description\"]\n }' | http PATCH \"http://localhost:8888/v1/buckets/blog/collections/builds\" \\\n --auth token:admin-token --verbose\n\nRefer to `Algolia official documentation `_ for more information about settings.\n\n\nRunning the tests\n=================\n\n::\n\n $ make tests\n\n\nChangelog\n=========\n\n1.1.0 (2019-04-26)\n------------------\n\n- Upgrade to algoliasearch 2.0\n\n\n1.0.0 (2019-02-08)\n------------------\n\n- Add support for collections whitelist. (#6)\n\n\n0.2.0 (2018-07-18)\n------------------\n\n**Bug fixes**\n\n- Update algolia settings.\n\n\n0.1.1 (2018-06-06)\n------------------\n\n**Bug fixes**\n\n- Fix reindex command.\n\n\n0.1.0 (2018-04-12)\n------------------\n\n**New features**\n\n- Flush indices when server is flushed\n- Perform insertions and deletion in bulk for better efficiency\n- Add heartbeat\n- Delete indices when buckets and collections are deleted\n- Support quick search from querystring\n- Support defining mapping from the ``algolia:settings`` property in the collection metadata\n\n**Bug fixes**\n\n- Only index records if the storage transaction is committed\n- Do not allow to search if no read permission on collection or bucket\n- Fix empty results response when plugin was enabled after collection creation\n\n**Internal changes**\n\n- Create index when collection is created",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/Kinto/kinto-algolia",
"keywords": "kinto algolia index",
"license": "Apache License (2.0)",
"maintainer": "",
"maintainer_email": "",
"name": "kinto-algolia",
"package_url": "https://pypi.org/project/kinto-algolia/",
"platform": "",
"project_url": "https://pypi.org/project/kinto-algolia/",
"project_urls": {
"Homepage": "https://github.com/Kinto/kinto-algolia"
},
"release_url": "https://pypi.org/project/kinto-algolia/1.1.0/",
"requires_dist": null,
"requires_python": "",
"summary": "Index and search records using Algolia.",
"version": "1.1.0"
},
"last_serial": 5193270,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "081e6da531d2d1a5f061ff7f9e02b84a",
"sha256": "2dec6adc55a768bc97905aaccd2b96d9d3f061dc405e0b671cdc2ad11c9ea0c4"
},
"downloads": -1,
"filename": "kinto_algolia-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "081e6da531d2d1a5f061ff7f9e02b84a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12578,
"upload_time": "2018-04-12T08:50:56",
"url": "https://files.pythonhosted.org/packages/45/46/3b3c07cc6d2a4008ffb2d138689ab2b7e206f4bd69f3a8b5251b76ce1be7/kinto_algolia-0.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "a2a3c4e8066aaabe0ba20179221fcb5c",
"sha256": "d1882d5b0d87613cf3a520f40ec8a10a97f70df9214659ed83facdbec34f6a40"
},
"downloads": -1,
"filename": "kinto-algolia-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "a2a3c4e8066aaabe0ba20179221fcb5c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14677,
"upload_time": "2018-04-12T08:50:55",
"url": "https://files.pythonhosted.org/packages/0e/db/bad43629bd5ddaeafb1e099ddbcd682673533723f25b6fd184b93509c44a/kinto-algolia-0.1.0.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "1b2691aadae0402286c5b9caf4676d1e",
"sha256": "aa7f2ff1fc9738756e758c46bd3979d886918f1f579c1b4be5a30117a4882a7b"
},
"downloads": -1,
"filename": "kinto_algolia-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1b2691aadae0402286c5b9caf4676d1e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12450,
"upload_time": "2018-06-06T07:17:31",
"url": "https://files.pythonhosted.org/packages/91/8f/729bf99d23394b3b928a7151f5b89bf59812789a17b767400258a4bb69a3/kinto_algolia-0.1.1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "b1c261402f19bae7b8e0cb0a6c491c07",
"sha256": "4dd04aba915644ae00abdc0329f5ee9aaeaec1a09c68be8218ef09843216961e"
},
"downloads": -1,
"filename": "kinto-algolia-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "b1c261402f19bae7b8e0cb0a6c491c07",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14489,
"upload_time": "2018-06-06T07:17:30",
"url": "https://files.pythonhosted.org/packages/0d/4f/9c88522bc2fe77f83db52f44c250c2a8147a704022dab0c3d14465d8f4ee/kinto-algolia-0.1.1.tar.gz"
}
],
"0.2.0": [
{
"comment_text": "",
"digests": {
"md5": "9bfee31333df7cac69c3c2a0a2215cd1",
"sha256": "73659ba666bfb54a4d710e786116c665504fa6cef115d12be66eceae258e0673"
},
"downloads": -1,
"filename": "kinto_algolia-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bfee31333df7cac69c3c2a0a2215cd1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12484,
"upload_time": "2018-07-18T11:19:27",
"url": "https://files.pythonhosted.org/packages/00/9e/d36307bedc2bab35b853b67a6e6fd16dd4819b6d2c6fe059ed7a714b63d1/kinto_algolia-0.2.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "cfd7bb95af8902fb09657db8b47e82f8",
"sha256": "39c5cf1a0fa0fe9455ed4588d1a181a6bc44c863e8b2394c04a03d5ce481f927"
},
"downloads": -1,
"filename": "kinto-algolia-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "cfd7bb95af8902fb09657db8b47e82f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14574,
"upload_time": "2018-07-18T11:19:26",
"url": "https://files.pythonhosted.org/packages/6e/7d/62884e664ac74aff9437a0ec492b8da40ea76754d965f07df8d2dd91eabf/kinto-algolia-0.2.0.tar.gz"
}
],
"1.0.0": [
{
"comment_text": "",
"digests": {
"md5": "8592b7ce60d6494d52e5e57331d205d8",
"sha256": "8f753ca75cd7c076d4832e0fe17656b930a7c9571d1cf116cc44b9d69a75db37"
},
"downloads": -1,
"filename": "kinto_algolia-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8592b7ce60d6494d52e5e57331d205d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10766,
"upload_time": "2019-02-08T17:25:19",
"url": "https://files.pythonhosted.org/packages/6d/50/1ecb70fdef7e3fb72434fe6d27f67473581a17d5f108cbf0fd99f4a02f4a/kinto_algolia-1.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "d708abc78a8749650698ab51471a62e7",
"sha256": "42ae0f6d26eb9bf1139a7669bcfb77ffb475041e6c9948f153a9ce31b7b5022e"
},
"downloads": -1,
"filename": "kinto-algolia-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d708abc78a8749650698ab51471a62e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15074,
"upload_time": "2019-02-08T17:25:18",
"url": "https://files.pythonhosted.org/packages/bf/17/b8ba81ea9854e240328eb314286f74a4d564d7ca7b70f9287ed65f6b540d/kinto-algolia-1.0.0.tar.gz"
}
],
"1.1.0": [
{
"comment_text": "",
"digests": {
"md5": "4f4270039068cc2ce378833b6c45a3b5",
"sha256": "841dae8a2424ee8d1e5574e687d0a90b4250790979f2ee75bcbd32fa16af9fd4"
},
"downloads": -1,
"filename": "kinto_algolia-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f4270039068cc2ce378833b6c45a3b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10817,
"upload_time": "2019-04-26T14:32:23",
"url": "https://files.pythonhosted.org/packages/1e/61/bb56558b11f48b11c81b93d2d107707af97936d4b432458388845267393a/kinto_algolia-1.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "9c80011e49e7b0f075551a14a009a2f5",
"sha256": "2661a2ceaebbfa41e89f4581c5faf294c9b7c7b172a3685c6eaaacd39bc37f96"
},
"downloads": -1,
"filename": "kinto-algolia-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9c80011e49e7b0f075551a14a009a2f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15176,
"upload_time": "2019-04-26T14:32:19",
"url": "https://files.pythonhosted.org/packages/dc/e7/f075f48b3bfce869ee8c088db6d1ad737d8a5f0ac2a809d1b5191cedb73e/kinto-algolia-1.1.0.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4f4270039068cc2ce378833b6c45a3b5",
"sha256": "841dae8a2424ee8d1e5574e687d0a90b4250790979f2ee75bcbd32fa16af9fd4"
},
"downloads": -1,
"filename": "kinto_algolia-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f4270039068cc2ce378833b6c45a3b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10817,
"upload_time": "2019-04-26T14:32:23",
"url": "https://files.pythonhosted.org/packages/1e/61/bb56558b11f48b11c81b93d2d107707af97936d4b432458388845267393a/kinto_algolia-1.1.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "9c80011e49e7b0f075551a14a009a2f5",
"sha256": "2661a2ceaebbfa41e89f4581c5faf294c9b7c7b172a3685c6eaaacd39bc37f96"
},
"downloads": -1,
"filename": "kinto-algolia-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "9c80011e49e7b0f075551a14a009a2f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15176,
"upload_time": "2019-04-26T14:32:19",
"url": "https://files.pythonhosted.org/packages/dc/e7/f075f48b3bfce869ee8c088db6d1ad737d8a5f0ac2a809d1b5191cedb73e/kinto-algolia-1.1.0.tar.gz"
}
]
}