Metadata-Version: 1.1
Name: algorithms
Version: 1.0
Summary: module of algorithms for Python
Home-page: https://github.com/nryoung/algorithms
Author: Nic Young
Author-email: nryoung@gmail.com
License: BSD
Description: Algorithms
        ==========
        
        .. image:: https://travis-ci.org/nryoung/algorithms.svg?branch=master
            :target: https://travis-ci.org/nryoung/algorithms
        
        .. image:: http://codecov.io/github/nryoung/algorithms/coverage.svg?branch=master
            :target: http://codecov.io/github/nryoung/algorithms?branch=master
        
        .. image:: https://readthedocs.org/projects/algorithms/badge/?version=latest
            :target: http://algorithms.readthedocs.org/en/latest/?badge=latest
        
        Algorithms is a library of algorithms and data structures implemented in Python.
        
        The main purpose of this library is to be an educational tool. You probably
        shouldn't use these in production, instead, opting for the optimized versions of
        these algorithms that can be found else where.
        
        You should totally check out the `docs`_ for implementation details, complexities
        and further info.
        
        Usage
        -----
        
        If you want to use the algorithms in your code it is as simple as:
        
        ::
        
            from algorithms.sorting import bubble_sort
        
            my_list = bubble_sort.sort(my_list)
        
        Features
        --------
        
        - Pseudo code, algorithm complexities and futher info with each algorithm.
        - Test coverage for each algorithm and data structure.
        - Super sweet `documentation`_.
        
        Installation:
        -------------
        
        Installation is as easy as:
        
        ::
        
            $ pip install algorithms
        
        
        Tests:
        ------
        
        Pytest is used as the main test runner and all Unit Tests can be run with:
        
        ::
        
            $ ./run_tests.py
        
        
        Contributing:
        -------------
        
        Contributions are always welcome. Check out the contributing guidelines to get
        started.
        
        .. _`docs`: http://algorithms.readthedocs.org/en/latest/
        .. _`documentation`: http://algorithms.readthedocs.org/en/latest/
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
