Skip to content

Commit

Permalink
Doc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
amartya00 committed Jul 26, 2021
1 parent c42c9d0 commit e875c38
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,19 @@
A collection of python classes and functions.

## Getting it
#### Github
Download it from github with a `git clone https://github.com/amartya00/thesoup.git`
Navigate to the root, and run all tests to ensure everything is working with `nosetests -w tst/ --nocapture`

Now install with `sudo pip3 install .`

#### PyPi
This is available on [PyPi](https://pypi.org/project/thesoup/) as well. Do a `sudo pip3 install thesoup` to install.

**NOTE**: If you do not have nose tests, install it with `sudo pip3 install nose`

**NOTE**: This is python3 only

Now install with `sudo pip3 install .`

## Components
### Classes
It has the following utility classes:
Expand All @@ -32,7 +36,8 @@ It has the following utility classes:
It has the following utility functions
- Collection related
- Flatten a nested collection `flatten`
- Flatten annested collection except the tuples `flatten_to_tuple`
- Flatten a nested collection except the tuples `flatten_to_tuple`
- Find all subsequences of a list `subsequence`

- Graph traversals
- Bread first search `bfs`
Expand Down

0 comments on commit e875c38

Please sign in to comment.