Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nryoung/algorithms

This repository is not maintained
https://github.com/nryoung/algorithms

Last synced: 12 days ago
JSON representation

This repository is not maintained

Awesome Lists containing this project

README

        

**This repository is no longer maintained, but is being kept around for educational purposes. If you want a more complete algorithms repo check out: https://github.com/keon/algorithms**
=====

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

.. image:: https://badge.fury.io/py/algorithms.svg
:target: https://badge.fury.io/py/algorithms

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/