aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/python/pygtrie/py3/README.rst
diff options
context:
space:
mode:
authorvitalyisaev <vitalyisaev@ydb.tech>2023-11-30 13:26:22 +0300
committervitalyisaev <vitalyisaev@ydb.tech>2023-11-30 15:44:45 +0300
commit0a98fece5a9b54f16afeb3a94b3eb3105e9c3962 (patch)
tree291d72dbd7e9865399f668c84d11ed86fb190bbf /contrib/python/pygtrie/py3/README.rst
parentcb2c8d75065e5b3c47094067cb4aa407d4813298 (diff)
downloadydb-0a98fece5a9b54f16afeb3a94b3eb3105e9c3962.tar.gz
YQ Connector:Use docker-compose in integrational tests
Diffstat (limited to 'contrib/python/pygtrie/py3/README.rst')
-rw-r--r--contrib/python/pygtrie/py3/README.rst66
1 files changed, 66 insertions, 0 deletions
diff --git a/contrib/python/pygtrie/py3/README.rst b/contrib/python/pygtrie/py3/README.rst
new file mode 100644
index 0000000000..41ca83db94
--- /dev/null
+++ b/contrib/python/pygtrie/py3/README.rst
@@ -0,0 +1,66 @@
+pygtrie
+=======
+
+.. image:: https://readthedocs.org/projects/pygtrie/badge/?version=latest
+ :target: http://pygtrie.readthedocs.io/en/latest/
+ :alt: Documentation build status (latest)
+
+.. image:: https://readthedocs.org/projects/pygtrie/badge/?version=stable
+ :target: http://pygtrie.readthedocs.io/en/stable/
+ :alt: Documentation build status (stable)
+
+.. image:: https://api.travis-ci.com/mina86/pygtrie.svg
+ :target: https://travis-ci.com/mina86/pygtrie
+ :alt: Continuous integration status
+
+pygtrie is a pure Python implementation of a trie data structure
+compatible with Python 2.x and Python 3.x.
+
+`Trie data structure <http://en.wikipedia.org/wiki/Trie>`_, also known
+as radix or prefix tree, is a tree associating keys to values where
+all the descendants of a node have a common prefix (associated with
+that node).
+
+The trie module contains ``Trie``, ``CharTrie`` and ``StringTrie``
+classes each implementing a mutable mapping interface, i.e. ``dict``
+interface. As such, in most circumstances, ``Trie`` could be used as
+a drop-in replacement for a ``dict``, but the prefix nature of the
+data structure is trie’s real strength.
+
+The module also contains ``PrefixSet`` class which uses a trie to
+store a set of prefixes such that a key is contained in the set if it
+or its prefix is stored in the set.
+
+Features
+--------
+
+- A full mutable mapping implementation.
+
+- Supports iterating over as well as deleting a subtrie.
+
+- Supports prefix checking as well as shortest and longest prefix
+ look-up.
+
+- Extensible for any kind of user-defined keys.
+
+- A PrefixSet supports “all keys starting with given prefix” logic.
+
+- Can store any value including None.
+
+Installation
+------------
+
+To install pygtrie, simply run::
+
+ pip install pygtrie
+
+or by adding line such as::
+
+ pygtrie == 2.*
+
+to project’s `requirements file
+<https://pip.pypa.io/en/latest/user_guide/#requirements-files>`_.
+Alternatively, if installation from source is desired, it can be
+achieved by executing::
+
+ python setup.py install