Metadata-Version: 2.1
Name: is-sorted
Version: 0.0.2
Summary: tool to check sorting
Home-page: https://github.com/vonafor/is_sorted
Author: Yan Mitrofanov
Author-email: mmxlviii@mail.ru
License: MIT License
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Provides-Extra: tests
Requires-Dist: pytest (>=5.3.2) ; extra == 'tests'

is_sorted
=========

*is_sorted* is a tiny Python tool to check if list (or any iterable) is sorted.

* compatible with builtin **sorted** function
* can check multiple keys sorting with custom order

Installation
------------

.. code-block:: console

    pip install is_sorted


Examples
--------

A simple way to check sorting

.. code-block:: python

   >>> from is_sorted import is_sorted
   >>> is_sorted([1, 2, 3, 4, 5, 6])
   True
   >>> is_sorted([1, 3, 2, 0])
   False
   >>> is_sorted([5, 4, 3, 2, 1], reverse=True)
   True
   >>> is_sorted([(1, 2), (2, 0), (3, 10), (3, 9), (4, 5)], key=lambda x: x[0])
   True

Multiple keys sorting

.. code-block:: python

   >>> data = [(1, 2), (1, 1), (2, 3), (2, 3), (3, 5)]
   >>> is_sorted(data, multi=[(lambda x: x[0], False), (lambda x: x[1], True)])
   True

