.. image:: https://readthedocs.org/projects/sayt/badge/?version=latest
:target: https://sayt.readthedocs.io/en/latest/
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/sayt-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/sayt-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/sayt-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/sayt-project
.. image:: https://img.shields.io/pypi/v/sayt.svg
:target: https://pypi.python.org/pypi/sayt
.. image:: https://img.shields.io/pypi/l/sayt.svg
:target: https://pypi.python.org/pypi/sayt
.. image:: https://img.shields.io/pypi/pyversions/sayt.svg
:target: https://pypi.python.org/pypi/sayt
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/sayt-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/sayt-project
------
.. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://sayt.readthedocs.io/en/latest/
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://sayt.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/sayt-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/sayt-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/sayt-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/sayt#files
Welcome to ``sayt`` (Search as you type) Documentation
==============================================================================
``sayt`` (Search as you type) is a Python library provide Google liked searching experience using your own dataset. It focus on quickly indexing your own dataset and start searching on it. ``sayt`` is not a full text search database, it doesn't support update/delete operation on your dataset, if your dataset is changed, ``sayt`` will delete the old one and re-index everything.
Features:
1. Support id search, ngram search, full text search, fuzzy search, range search.
2. Query results are automatically cached, and will expire based on your configuration.
.. _install:
Install
------------------------------------------------------------------------------
``sayt`` is released on PyPI, so all you need is to:
.. code-block:: console
$ pip install sayt
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade sayt
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/sayt-project",
"name": "sayt",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@gmail.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/db/8a/244fa94ed635a1e53d32f8bd1e84e031c2049e7704f53ae848ea331f9f04/sayt-0.6.5.tar.gz",
"platform": "Windows",
"description": "\n.. image:: https://readthedocs.org/projects/sayt/badge/?version=latest\n :target: https://sayt.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/sayt-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/sayt-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/sayt-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/sayt-project\n\n.. image:: https://img.shields.io/pypi/v/sayt.svg\n :target: https://pypi.python.org/pypi/sayt\n\n.. image:: https://img.shields.io/pypi/l/sayt.svg\n :target: https://pypi.python.org/pypi/sayt\n\n.. image:: https://img.shields.io/pypi/pyversions/sayt.svg\n :target: https://pypi.python.org/pypi/sayt\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/sayt-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/sayt-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://sayt.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://sayt.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/sayt-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/sayt-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/sayt-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/sayt#files\n\n\nWelcome to ``sayt`` (Search as you type) Documentation\n==============================================================================\n``sayt`` (Search as you type) is a Python library provide Google liked searching experience using your own dataset. It focus on quickly indexing your own dataset and start searching on it. ``sayt`` is not a full text search database, it doesn't support update/delete operation on your dataset, if your dataset is changed, ``sayt`` will delete the old one and re-index everything.\n\nFeatures:\n\n1. Support id search, ngram search, full text search, fuzzy search, range search.\n2. Query results are automatically cached, and will expire based on your configuration.\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``sayt`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install sayt\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade sayt\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Package short description.",
"version": "0.6.5",
"project_urls": {
"Download": "https://pypi.python.org/pypi/sayt/0.6.5#downloads",
"Homepage": "https://github.com/MacHu-GWU/sayt-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2fa0ec442d624db4edb2fbc9097455a29cf24b87cf5b9f5332a384e091b61248",
"md5": "daef985ad9788387b5125622aebfbb5a",
"sha256": "5934785495a10150b2d718c1d8c3a31d3e36db8a0db4ae54a52da7e8dbf5dc1b"
},
"downloads": -1,
"filename": "sayt-0.6.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "daef985ad9788387b5125622aebfbb5a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 21291,
"upload_time": "2023-11-01T19:33:54",
"upload_time_iso_8601": "2023-11-01T19:33:54.512128Z",
"url": "https://files.pythonhosted.org/packages/2f/a0/ec442d624db4edb2fbc9097455a29cf24b87cf5b9f5332a384e091b61248/sayt-0.6.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "db8a244fa94ed635a1e53d32f8bd1e84e031c2049e7704f53ae848ea331f9f04",
"md5": "fb0c5f61bf135c068f12f22872fa374b",
"sha256": "e0c54c3c0432ee2c88022204a9650fa0ad852207c200637df27e6ca025743feb"
},
"downloads": -1,
"filename": "sayt-0.6.5.tar.gz",
"has_sig": false,
"md5_digest": "fb0c5f61bf135c068f12f22872fa374b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25686,
"upload_time": "2023-11-01T19:33:57",
"upload_time_iso_8601": "2023-11-01T19:33:57.446048Z",
"url": "https://files.pythonhosted.org/packages/db/8a/244fa94ed635a1e53d32f8bd1e84e031c2049e7704f53ae848ea331f9f04/sayt-0.6.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-01 19:33:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "sayt-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "sayt"
}
JSON
