{{PROJECT_NAME}}

{{BADGES}}

{{DESCRIPTION}}

{{IMAGE_PREVIEW}}

Installation

It is recommended to use this package together with virtualenv and virtualenvwrapper to work with python virtual environments more suitable. Make sure the installed python interpreters work without errors on the current operating system. To install this package you are to use the pip package manager by running the following command:

python3 -m pip install {{PROJECT_NAME}}

You can also install this python package on your working machine from source code:

# Step -- 1.
git clone --depth=1 --branch=master {{GIT_REPOSITORY_URL}}

# Step -- 2.
cd ./{{PROJECT_NAME}}/

# Step -- 3.
echo 'All the required steps.'

Basic Usage

{{USAGE_DESCRIPTION}}

echo 'Usage examples.'

Contributing

Pull requests are welcome. Please open an issue first to discuss what should be changed.

Please make sure to update tests as appropriate.

# Step -- 1.
python3 -m venv .venv && source ./.venv/bin/activate && pip install pre-commit tox

# Step -- 2.
make hooks

# Step -- 3.
make tests && make lint

License

MIT