https://github.com/grantjenks/python-sortedcollections

Python Sorted Collections Library
https://github.com/grantjenks/python-sortedcollections

data-types dict list python set sorted

Last synced: 6 months ago
JSON representation

Python Sorted Collections Library

• Host: GitHub
• URL: https://github.com/grantjenks/python-sortedcollections
• Owner: grantjenks
• License: other
• Created: 2015-07-31T17:26:24.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2022-11-28T20:27:35.000Z (almost 3 years ago)
• Last Synced: 2025-03-30T17:09:53.143Z (6 months ago)
• Topics: data-types, dict, list, python, set, sorted
• Language: Python
• Homepage: http://www.grantjenks.com/docs/sortedcollections/
• Size: 209 KB
• Stars: 104
• Watchers: 4
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Python Sorted Collections

=========================

`Sorted Collections`_ is an Apache2 licensed Python sorted collections library.

Features

--------

- Pure-Python

- Depends on the `Sorted Containers

  `_ module.

- ValueSortedDict - Dictionary with (key, value) item pairs sorted by value.

- ItemSortedDict - Dictionary with key-function support for item pairs.

- NearestDict - Dictionary with nearest-key lookup.

- OrderedDict - Ordered dictionary with numeric indexing support.

- OrderedSet - Ordered set with numeric indexing support.

- IndexableDict - Dictionary with numeric indexing support.

- IndexableSet - Set with numeric indexing support.

- SegmentList - List with fast random access insertion and deletion.

- 100% code coverage testing.

- Developed on Python 3.9

- Tested on CPython 3.6, 3.7, 3.8, and 3.9

.. image:: https://github.com/grantjenks/python-sortedcollections/workflows/integration/badge.svg

   :target: https://github.com/grantjenks/python-sortedcollections/actions?query=workflow%3Aintegration

.. image:: https://github.com/grantjenks/python-sortedcollections/workflows/release/badge.svg

   :target: https://github.com/grantjenks/python-sortedcollections/actions?query=workflow%3Arelease

Quickstart

----------

Installing `Sorted Collections`_ is simple with `pip

`_::

    $ pip install sortedcollections

You can access documentation in the interpreter with Python's built-in `help`

function:

.. code-block:: python

    >>> from sortedcollections import ValueSortedDict

    >>> help(ValueSortedDict)  # doctest: +SKIP

.. _`Sorted Collections`: http://www.grantjenks.com/docs/sortedcollections/

Recipes

-------

- `Value Sorted Dictionary Recipe`_

- `Item Sorted Dictionary Recipe`_

- `Nearest Dictionary Recipe`_

- `Ordered Dictionary Recipe`_

- `Ordered Set Recipe`_

- `Indexable Dictionary Recipe`_

- `Indexable Set Recipe`_

- `Segment List Recipe`_

.. _`Value Sorted Dictionary Recipe`: http://www.grantjenks.com/docs/sortedcollections/valuesorteddict.html

.. _`Item Sorted Dictionary Recipe`: http://www.grantjenks.com/docs/sortedcollections/itemsorteddict.html

.. _`Nearest Dictionary Recipe`: http://www.grantjenks.com/docs/sortedcollections/nearestdict.html

.. _`Ordered Dictionary Recipe`: http://www.grantjenks.com/docs/sortedcollections/ordereddict.html

.. _`Ordered Set Recipe`: http://www.grantjenks.com/docs/sortedcollections/orderedset.html

.. _`Indexable Dictionary Recipe`: http://www.grantjenks.com/docs/sortedcollections/indexabledict.html

.. _`Indexable Set Recipe`: http://www.grantjenks.com/docs/sortedcollections/indexableset.html

.. _`Segment List Recipe`: http://www.grantjenks.com/docs/sortedcollections/segmentlist.html

Reference and Indices

---------------------

- `Sorted Collections Documentation`_

- `Sorted Collections at PyPI`_

- `Sorted Collections at Github`_

- `Sorted Collections Issue Tracker`_

.. _`Sorted Collections Documentation`: http://www.grantjenks.com/docs/sortedcollections/

.. _`Sorted Collections at PyPI`: https://pypi.python.org/pypi/sortedcollections/

.. _`Sorted Collections at Github`: https://github.com/grantjenks/python-sortedcollections

.. _`Sorted Collections Issue Tracker`: https://github.com/grantjenks/python-sortedcollections/issues

Sorted Collections License

--------------------------

Copyright 2015-2021 Grant Jenks

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.