Skip to main content

Essentials for our projects.

Project description

fa-essentials

A library with essentials needed in every backend python app. e.g. logging, local db connection, filtering, formatting etc.

TODO

  • make this library private.

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 fa-essentials

Import in modules without the dash (e.g.): from faessentials.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 deactivateto 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

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 fa-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

The Release process is executed by github actions.

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

fa_essentials-1.0.153.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

fa_essentials-1.0.153-py3-none-any.whl (13.6 kB view details)

Uploaded Python 3

File details

Details for the file fa_essentials-1.0.153.tar.gz.

File metadata

  • Download URL: fa_essentials-1.0.153.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for fa_essentials-1.0.153.tar.gz
Algorithm Hash digest
SHA256 75fdc2c3a4c59ba9de50a8ef818009a7d19194734a73955cb56bfd2c57d263f7
MD5 9faec07c903c3ea7ed96fb878f91dce4
BLAKE2b-256 77740a25839c14503c2bb4ca2241ed35f02502a574555d39d082f30440bc30d2

See more details on using hashes here.

File details

Details for the file fa_essentials-1.0.153-py3-none-any.whl.

File metadata

File hashes

Hashes for fa_essentials-1.0.153-py3-none-any.whl
Algorithm Hash digest
SHA256 b420ed4c9f9c6086668c280b48fd08c005a2003ca1c50752462156fe71d1498c
MD5 11749255542688b6c18b730c01eede2d
BLAKE2b-256 ca9e1c4c913f4895848b3badd32f16455ad6df275cef45b4b9ff63d871893801

See more details on using hashes here.

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