Skip to content
This repository has been archived by the owner on Nov 6, 2018. It is now read-only.

Latest commit

 

History

History
73 lines (45 loc) · 1.9 KB

README.rst

File metadata and controls

73 lines (45 loc) · 1.9 KB

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

https://travis-ci.org/nryoung/algorithms.svg?branch=master http://codecov.io/github/nryoung/algorithms/coverage.svg?branch=master https://readthedocs.org/projects/algorithms/badge/?version=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.