A Python algorithms module for learning
Project description
Pygorithm
=========
.. image:: https://readthedocs.org/projects/pygorithm/badge/?version=latest
:target: http://pygorithm.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/Python-3.6-brightgreen.svg
:target: https://github.com/OmkarPathak/pygorithm
:alt: Python 3.6
| A Python module to learn all the major algorithms on the go!
| Purely for educational purposes
Features
~~~~~~~~
* Super easy to use
* A very easy to understand `Documentation <http://pygorithm.readthedocs.io/en/latest/>`_
* Get the code right in your editor
* Get time complexities on the go
Installation
~~~~~~~~~~~~
* Just fire the following command in your terminal:
::
pip3 install pygorithm
- | It's that easy. If you are using Python 2.7 use pip instead. Depending on your
| permissions, you might need to use ``pip install --user pygorithm`` to install.
* Or you can download the source code from `here <https://github.com/OmkarPathak/pygorithm>`_, and then just install the package using
::
python setup.py install
Quick Start Guide
~~~~~~~~~~~~~~~~~
* To sort your list
.. code:: python
from pygorithm.sorting import bubble_sort
myList = [12, 4, 3, 5, 13, 1, 17, 19, 15]
sortedList = bubble_sort.sort(myList)
print(sortedList)
* To get the code for function used
.. code:: python
from pygorithm.sorting import bubble_sort
code = bubble_sort.get_code()
print(code)
* To get the time complexity of an algorithm
.. code:: python
from pygorithm.sorting import bubble_sort
time_complexity = bubble_sort.time_complexities()
print(time_complexity)
* To see all the available functions in a module. For example, if you want to see what all sorts are available in the sorting module, then just do
.. code:: python
>>> from pygorithm.sorting import modules
>>> modules()
['bubble_sort', 'bucket_sort', 'counting_sort', 'heap_sort', 'insertion_sort', 'merge_sort', 'quick_sort', 'selection_sort', 'shell_sort']
Tests
~~~~~
* Just type in the following command to run the tests
::
python3 -m unittest
* This will run all the tests defined in the files of the ``tests/`` directory
Donation
~~~~~~~~
If you have found my softwares to be of any use to you, do consider helping me pay my internet bills. This would encourage me to create many such softwares :)
- `PayPal <https://paypal.me/omkarpathak27>`_
- `₹ (INR) <https://www.instamojo.com/@omkarpathak/>`_
=========
.. image:: https://readthedocs.org/projects/pygorithm/badge/?version=latest
:target: http://pygorithm.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://img.shields.io/badge/Python-3.6-brightgreen.svg
:target: https://github.com/OmkarPathak/pygorithm
:alt: Python 3.6
| A Python module to learn all the major algorithms on the go!
| Purely for educational purposes
Features
~~~~~~~~
* Super easy to use
* A very easy to understand `Documentation <http://pygorithm.readthedocs.io/en/latest/>`_
* Get the code right in your editor
* Get time complexities on the go
Installation
~~~~~~~~~~~~
* Just fire the following command in your terminal:
::
pip3 install pygorithm
- | It's that easy. If you are using Python 2.7 use pip instead. Depending on your
| permissions, you might need to use ``pip install --user pygorithm`` to install.
* Or you can download the source code from `here <https://github.com/OmkarPathak/pygorithm>`_, and then just install the package using
::
python setup.py install
Quick Start Guide
~~~~~~~~~~~~~~~~~
* To sort your list
.. code:: python
from pygorithm.sorting import bubble_sort
myList = [12, 4, 3, 5, 13, 1, 17, 19, 15]
sortedList = bubble_sort.sort(myList)
print(sortedList)
* To get the code for function used
.. code:: python
from pygorithm.sorting import bubble_sort
code = bubble_sort.get_code()
print(code)
* To get the time complexity of an algorithm
.. code:: python
from pygorithm.sorting import bubble_sort
time_complexity = bubble_sort.time_complexities()
print(time_complexity)
* To see all the available functions in a module. For example, if you want to see what all sorts are available in the sorting module, then just do
.. code:: python
>>> from pygorithm.sorting import modules
>>> modules()
['bubble_sort', 'bucket_sort', 'counting_sort', 'heap_sort', 'insertion_sort', 'merge_sort', 'quick_sort', 'selection_sort', 'shell_sort']
Tests
~~~~~
* Just type in the following command to run the tests
::
python3 -m unittest
* This will run all the tests defined in the files of the ``tests/`` directory
Donation
~~~~~~~~
If you have found my softwares to be of any use to you, do consider helping me pay my internet bills. This would encourage me to create many such softwares :)
- `PayPal <https://paypal.me/omkarpathak27>`_
- `₹ (INR) <https://www.instamojo.com/@omkarpathak/>`_
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pygorithm-1.0.0.tar.gz
(17.1 kB
view hashes)
Built Distribution
Close
Hashes for pygorithm-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95d0716dc1bac172ec13dff690f5c279f6bd4ce026ce12544c1d55555264e458 |
|
MD5 | b8ba1e5d335b30faf60140e53ba3b762 |
|
BLAKE2b-256 | 4ff4066d8440413d2889e08cd3aa1fa26cf1becc0655edd4156da0a8b04b14a8 |