Skip to main content

Python helper functions and classes.

Project description

helpsk package

Helper package for python.

NOTE: This package is tested on Python 3.10, 3.11

  • 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

Docker

See Makefile for all commands.

To build the docker container:

make docker_build

To run the terminal inside the docker container:

make docker_zsh

To run the unit tests (including linting and doc-tests) from the commandline inside the docker container:

make tests

To run the unit tests (including linting and doc-tests) from the commandline outside the docker container:

make docker_tests

To build the python package and uploat do PyPI via twine from the commandline outside the docker container:

make all

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.63.tar.gz (6.6 MB view details)

Uploaded Source

Built Distribution

helpsk-0.1.63-py3-none-any.whl (69.6 kB view details)

Uploaded Python 3

File details

Details for the file helpsk-0.1.63.tar.gz.

File metadata

  • Download URL: helpsk-0.1.63.tar.gz
  • Upload date:
  • Size: 6.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for helpsk-0.1.63.tar.gz
Algorithm Hash digest
SHA256 b505f8339d179c0a75d0780f61a75bc1cfff07f6ae36a73782d46444546525c9
MD5 94575134b7965b6afcdb5c3616dd25a2
BLAKE2b-256 7a7775aaecc2c4bdc14d6f87b2dcb36822a742c53f7e036a89cc164ef392da17

See more details on using hashes here.

File details

Details for the file helpsk-0.1.63-py3-none-any.whl.

File metadata

  • Download URL: helpsk-0.1.63-py3-none-any.whl
  • Upload date:
  • Size: 69.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.11

File hashes

Hashes for helpsk-0.1.63-py3-none-any.whl
Algorithm Hash digest
SHA256 a7e7e3d3f45cc07d94216329e36db7e3f626045f7d22e919b5b05b063f4f9ed0
MD5 33d996bb45ad2497cdf7ca8b2ef95003
BLAKE2b-256 514b876115f3ee9133bc3df6a65fa134ccd81da167ff72e800f0a91bc6679e40

See more details on using hashes here.

Supported by

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