Skip to main content

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)
  • 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


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.31.tar.gz (83.0 kB view hashes)

Uploaded Source

Built Distribution

helpsk-0.1.31-py3-none-any.whl (91.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page