Python Snippets

Repository for some of my simple Python functions and snippets. Each directory and/or python package has a readme for more information about the Python program

Clone the repo

git clone

Activate a virtual env

virtualenv venv

or activate a virtual env with Python 3.+(this is recommended as most snippets run on Python3)

virtualenv -p python3 venv

install the requirements

poetry install

Enjoy!

Running tests

To run tests use py.test

$ py.test tests

This will run all the tests in the tests directory

To add tests, name your test folders test_<MODULE_TO_TEST>.py. This is to enable py.test to detect your tests. Place these tests in the tests folder.

Special file (documenter)

I call this special because it prints out the documentation for Python built in functions Python has many built-in functions, and if you do not know how to use it, you can read document online or find some books. But Python has a built-in document function for every built-in functions. Prints some Python built-in functions documents, such as abs(), int(), raw_input()

Hint The built-in document method is doc is used