Metadata-Version: 2.1
Name: prioheap
Version: 0.0.2
Summary: Priority queue with a sane API
Home-page: https://github.com/adefossez/prioheap
Author: Alexandre Défossez
Author-email: alexandre.defossez@gmail.com
License: Unlicense license
Description: 
        # PrioHeap
        
        ![test badge](https://github.com/adefossez/prioheap/workflows/test/badge.svg)
        
        A priority queue from the textbooks. Python implementation is surprinsigly not modern.
        
        ## Installation
        
        ```python
        pip3 install prioheap
        ```
        
        ## Usage
        
        The API is dead simple:
        
        ```python
        import prioheap
        
        prio = prioheap.PrioHeap()
        prio.add(0) # add element
        prio.add(3)
        prio.peak()  # return highest element, e.g. 3
        prio.add(1)
        prio.pop()  # remove and return highest element, 3.
        
        len(prio), bool(prio)  # those are supported
        iter(prio), list(prio)  # iterate elements in decreasing order
        ```
        
        ## Test
        
        To run the unit tests from the root of this repository:
        ```python
        python3 -m tests
        ```
        
        ## License
        
        License is Unlincense, so public domain.
        
Platform: UNKNOWN
Classifier: Topic :: Text Processing
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
