Essentials for our TKS projects.
Project description
tks-essentials
A library with essentials needed in every backend python app. e.g. logging, local db connection, filtering, formatting etc.
Sponsors
Freya Alpha, The Kára System, Spark & Hale Robotic Industries
General
Run and compiled for Python 3.9.13. Expected to run for Python 3+
Development
Testing
run tests with pytest -s -vv
to see all the details.
Installation as Consuming Developer
Simply run: pip install tks-essentials
Import in modules without the dash (e.g.): from tksessentials.globallogger import GlobalLogger
Setup as Contributor
Create the virtul environment:
py -m venv .venv
Start the Environment:
./.venv/Scripts/activate
(or allow VS Code to start it). Use deactivate
to stop it.
All the required libraries must be listed in requirements.txt and installed by
python -m pip install -r .\requirements.txt
For Dev use
python -m pip install -r .\requirements-dev.txt
To cleanup the environment run:
pip3 freeze > to-uninstall.txt
and then
pip3 uninstall -y -r to-uninstall.txt
or
pip3 install pip-autoremove
Testing
Before running the tests, make sure that the utils.py can find the root directory. Either set the PROJECT_ROOT environement variable to the root directory, or simply create a config or a logs directory within the project root. Then run the pytests.
Build Library
Prerequisite: make sure that you give your Operating System user the right to modify files in the python directory. The directory where pyhton is installed.
Use
python setup.py bdist_wheel
to create the dist, build and .eggs folder.
Reference from a different project
In order to use your own version of the project - to maybe contribute to the library - simply clone the code from github into new directory. Then add the path of that new directory to the requirements.txt file of your project. Then change in tks-essentials whatever you recommend to improve. Don't forget the Open-Closed Principle: extend only (unless it requires a breaking change)
Releasing a new version / CICD Process
This is entirely executed with Github Actions.
Visual Studio Code --> GitHub Actions --> Build within Github Actions --> Uploaded by Github Actions to pypi.org.
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
Built Distribution
Hashes for tks_essentials-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6dd38c1b5f03015c332ce8057f028d842dcfbf39fd7d32b6ce32c70028ccbe3c |
|
MD5 | bfd734645b6ccfb333cc3a75ceae70e0 |
|
BLAKE2b-256 | 4a269b3a84e64d9b2e4a9c7dbf5ea43f1ac6c3790a17d9bb7650353321822297 |