Metadata-Version: 2.1
Name: bin_tree
Version: 0.2.1
Summary: A python module that provides mutable mappings and sets implemented with binary trees.
Home-page: https://github.com/s-ball/bin_tree
Author: SBA
Author-email: s-ball@laposte.net
License: MIT License
Project-URL: Changelog, https://github.com/s-ball/bin_tree/blob/master/CHANGES.txt
Description: <!--
        [![Travis-CI Build Status](https://travis-ci.com/s-ball/bin_tree.svg?branch=master)](https://travis-ci.com/s-ball/pyimgren) [![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/salqj2q1h8mid74t/branch/master?svg=true)](https://ci.appveyor.com/project/s-ball/pyimgren/branch/master)
        [![Documentation Status](https://readthedocs.org/projects/bin_tree/badge/?version=latest)](https://pyimgren.readthedocs.io/en/latest/?badge=latest)
        -->
        # bin_tree
        A python module that provides mutable mappings and sets implemented with binary trees.
        
        ## Current status
        
        This package will be distributed in PyPI starting with version 0.1.0. It can be used by end users, but should be considered at beta quality because it still lacks extensive testing. Its full source is available from [GitHUB](https://github.com/s-ball/pyimgren).
        
        ## Goals
        
        This module intends to be used as a normal mapping. It provides various
        implementations, a non balancing one, an AVL one, and a red-black
        one.
        
        Portability is very important here:
        * few dependencies: a Python 3 (tested for >= 3.5)
        * no additional module requirements
        
        ## Usage:
        To be done
        
        ## Installing
        
        ### End user installation
        
        With pip: `pip install bin_tree`.
        
        ### Developer installation
        
        If you want to contribute or integrate `bin_tree` in your own code, you should get a copy of the full tree from [GitHUB](https://github.com/s-ball/pyimgren):
        
        ```
        git clone https://github.com/s-ball/bin_tree [your_working_copy_folder]
        ```
        
        #### Running the tests
        
        As the project only uses unittest, you can simply run tests from the main folder with:
        
        ```
        python -m unittest discover
        ```
        
        ## Contributing
        
        As this project is developed on my free time, I cannot guarantee very fast feedbacks. Anyway, I shall be glad to receive issues or pull requests on GitHUB. 
        
        ## Versioning
        
        This project uses a standard Major.Minor.Patch versioning pattern. Inside a major version, public API stability is expected (at least after 1.0.0 version will be published).
        
        ## License
        
        This project is licensed under the MIT License - see the LICENSE.txt file for details
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
