Metadata-Version: 1.0
Name: algos-py
Version: 0.4.1
Summary: Classic computer science algorithms in Python
Home-page: https://github.com/all3fox/algos-py
Author: Aleksandr Lisianoi
Author-email: all3fox@gmail.com
License: MIT
Description: Package algos-py
        ################
        
        .. image:: https://travis-ci.org/all3fox/algos-py.svg?branch=master
           :target: https://travis-ci.org/all3fox/algos-py
        .. image:: https://ci.appveyor.com/api/projects/status/j5ireye9mly39f9m/branch/master?svg=true
           :target: https://ci.appveyor.com/project/all3fox/algos-py
        .. image:: https://coveralls.io/repos/github/all3fox/algos-py/badge.svg?branch=master
           :target: https://coveralls.io/github/all3fox/algos-py?branch=master
        .. image:: https://codecov.io/gh/all3fox/algos-py/coverage.png
           :target: https://codecov.io/gh/all3fox/algos-py
        .. image:: https://pyup.io/repos/github/all3fox/algos-py/shield.svg
           :target: https://pyup.io/repos/github/all3fox/algos-py/
        .. image:: https://requires.io/github/all3fox/algos-py/requirements.svg?branch=master
           :target: https://requires.io/github/all3fox/algos-py/requirements/?branch=master
        |
        .. image:: https://img.shields.io/pypi/format/algos-py.svg
           :target: https://pypi.python.org/pypi/algos-py/
        .. image:: https://img.shields.io/pypi/v/algos-py.svg
           :target: https://pypi.python.org/pypi/algos-py/
        .. image:: https://img.shields.io/github/license/all3fox/algos-py.svg
           :target: https://choosealicense.com/licenses/mit/
        
        What is algos-py?
        =================
        
        This package contains implementations of some classic computer
        science algorithms. My primary goal is to understand those algorithms
        and the best way to do that is to code them myself.
        
        Along the way I practice test driven development (with pytest_),
        continuous integration (with travis_ and appveyor_), coverage
        tracking (with coveralls_ and codecov_), version control (with git_,
        github_ and gitlab_), documentation (with sphinx_ and readthedocs_)
        and a lot more.
        
        ..
           What algorithms are ready?
           ==========================
        
           TODO
        
        ..
           How to install?
           ===============
        
           Installing from github
           ----------------------
        
           TODO
        
           Installing from pip
           -------------------
        
           TODO
        
        How to test?
        ============
        
        To run all of the unit-tests:
        
        .. code-block:: bash
        
           $ pytest -n 2
        
        To run unit-tests for a specific module:
        
        .. code-block:: bash
        
           $ pytest ./tests/test_heap.py
        
        To run all the unit-tests and produce a coverage report:
        
        .. code-block:: bash
        
           $ pytest -n 2 --cov=src
        
        ..   How to uninstall?
             =================
        
        
        Where to find?
        ==============
        
        Primary repository:
        
        https://github.com/all3fox/algos-py
        
        Secondary (mirror) repository:
        
        https://gitlab.com/all3fox/algos-py
        
        Release procedure: change version in `setup.py`, then
        
        .. code-block:: bash
        
           $ git add setup.py
           $ git commit -m "Bump version to 1.0.0"
           $ git tag v1.0.0
           $ git push origin master && git push origin --tags
           $ git push gitlab master && git push gitlab --tags
           $ python setup.py sdist
           $ twine upload ./dist/algos-py-1.0.0.tar.gz
        
        
        .. _travis-ci.org: https://travis-ci.org/all3fox/algos-py
        .. _travis: travis-ci.org_
        .. _appveyor.com: https://ci.appveyor.com/project/all3fox/algos-py
        .. _appveyor: appveyor.com_
        .. _coveralls.io: https://coveralls.io/github/all3fox/algos-py
        .. _coveralls: coveralls.io_
        .. _codecov.io: https://codecov.io/gh/all3fox/algos-py
        .. _codecov: codecov.io_
        .. _nose: https://nose.readthedocs.io/en/latest/
        .. _pytest: https://docs.pytest.org/en/latest/
        .. _git: https://git-scm.com/
        .. _github.com: https://github.com
        .. _github: github.com_
        .. _gitlab.com: https://gitlab.com
        .. _gitlab: gitlab.com_
        .. _sphinx: http://www.sphinx-doc.org/en/stable/
        .. _readthedocs.org: https://readthedocs.org/
        .. _readthedocs: readthedocs.org_
        
Platform: linux
