# fa-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 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 `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
```
### 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "fa-essentials",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "finance, trading, models",
"author": null,
"author_email": "Brayan <brayan@sparkandhale.com>",
"download_url": "https://files.pythonhosted.org/packages/bb/2d/0b21f851a02a1b78278233b01e743b43a8d32bbe317481c1f353b9811281/fa_essentials-1.0.123.tar.gz",
"platform": null,
"description": "# fa-essentials\nA library with essentials needed in every backend python app. e.g. logging, local db connection, filtering, formatting etc.\n\n## Sponsors\nFreya Alpha,\nThe K\u00e1ra System,\nSpark & Hale Robotic Industries\n\n## General\nRun and compiled for Python 3.9.13.\nExpected to run for Python 3+\n\n## Development\n\n### Testing\nrun tests with `pytest -s -vv` to see all the details.\n\n### Installation as Consuming Developer\n\nSimply run: `pip install fa-essentials`\n\nImport in modules without the dash (e.g.): `from faessentials.globallogger import GlobalLogger`\n\n### Setup as Contributor\nCreate the virtul environment: \n```\npy -m venv .venv\n```\nStart the Environment: \n```\n./.venv/Scripts/activate\n```\n (or allow VS Code to start it). Use `deactivate`to stop it.\n\nAll the required libraries must be listed in requirements.txt and installed by \n```\npython -m pip install -r .\\requirements.txt\n```\nFor Dev use \n```\npython -m pip install -r .\\requirements-dev.txt\n```\n\nTo cleanup the environment run:\n```\npip3 freeze > to-uninstall.txt\n```\n and then\n```\npip3 uninstall -y -r to-uninstall.txt\n```\n\nor \n```\npip3 install pip-autoremove\n```\n\n### Build Library\nPrerequisite: make sure that you give your Operating System user the right to modify files in the python directory. The directory where pyhton is installed.\nUse \n```python setup.py bdist_wheel```\n to create the dist, build and .eggs folder.\n\n## Reference from a different project\nIn 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)\n\n\n## Releasing a new version\nThe Release process is executed by github actions.\n",
"bugtrack_url": null,
"license": null,
"summary": "Essentials for our projects.",
"version": "1.0.123",
"project_urls": {
"Homepage": "https://github.com/Freya-Alpha/fa-essentials"
},
"split_keywords": [
"finance",
" trading",
" models"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0f3a92b95c50c937b5c8c719ab2a229ef290e5ea3533c1a8451627979b9aa64",
"md5": "b3333621fed57bb1af7079bfc74a7835",
"sha256": "24bb645ef051417b59db1af1341247b4395ff24be3d39907ed9fca77ffaf7183"
},
"downloads": -1,
"filename": "fa_essentials-1.0.123-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3333621fed57bb1af7079bfc74a7835",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13573,
"upload_time": "2024-04-18T19:46:24",
"upload_time_iso_8601": "2024-04-18T19:46:24.344463Z",
"url": "https://files.pythonhosted.org/packages/a0/f3/a92b95c50c937b5c8c719ab2a229ef290e5ea3533c1a8451627979b9aa64/fa_essentials-1.0.123-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bb2d0b21f851a02a1b78278233b01e743b43a8d32bbe317481c1f353b9811281",
"md5": "040c34b4132f13d3729a1f2c82642ccd",
"sha256": "ac425b81bcc2c83cedccf24b3a7ddcca3f6879e8ba5e2c36aa763a86545a3787"
},
"downloads": -1,
"filename": "fa_essentials-1.0.123.tar.gz",
"has_sig": false,
"md5_digest": "040c34b4132f13d3729a1f2c82642ccd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 15009,
"upload_time": "2024-04-18T19:46:25",
"upload_time_iso_8601": "2024-04-18T19:46:25.772592Z",
"url": "https://files.pythonhosted.org/packages/bb/2d/0b21f851a02a1b78278233b01e743b43a8d32bbe317481c1f353b9811281/fa_essentials-1.0.123.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 19:46:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Freya-Alpha",
"github_project": "fa-essentials",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "wheel",
"specs": []
},
{
"name": "setuptools",
"specs": []
},
{
"name": "twine",
"specs": []
},
{
"name": "redis",
"specs": []
},
{
"name": "aiokafka",
"specs": []
},
{
"name": "fastavro",
"specs": []
},
{
"name": "pyyaml",
"specs": []
},
{
"name": "cryptography",
"specs": []
},
{
"name": "email-validator",
"specs": []
},
{
"name": "ipaddress",
"specs": []
},
{
"name": "fa-models",
"specs": []
},
{
"name": "fastapi",
"specs": []
},
{
"name": "deprecated",
"specs": []
}
],
"lcname": "fa-essentials"
}
JSON
