Python helper functions and classes.
Project description
helpsk package
Helper package for python.
NOTE: This package requires Python >=3.9
- package source in
/helpsk
- unit tests in
/tests
Installing
pip install helpsk
Contributing
Coding Standards
- Coding standards should follow PEP 8 (Style Guide for Python Code)
- https://peps.python.org/pep-0008/
- Exceptions:
- use max line length of
110
rather than the suggested79
- use max line length of
- document all files, classes, functions
- following existing documentation style
Create Virtual Environment
The following command will install all dependencies as a virtual environment located in ./venv/
make environment
To activate the virtual environment in the terminal, use:
source .venv/bin/activate
to deactivate, simply use:
source .venv/bin/activate
To configure PyCharm (etc.) to use the virtual environment, point the environment to .venv/bin/python3
Pre-Check-in
Unit Tests
The unit tests in this project are all found in the /tests
directory.
In the terminal, in the project directory, either run the Makefile command,
make tests
or the python command for running all tests
python -m unittest discover ./tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
helpsk-0.1.27.tar.gz
(80.9 kB
view hashes)
Built Distribution
helpsk-0.1.27-py3-none-any.whl
(89.3 kB
view hashes)