| Name | tks-essentials JSON |
| Version |
0.1.19
JSON |
| download |
| home_page | None |
| Summary | Essentials for our TKS projects. |
| upload_time | 2024-11-20 14:20:45 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
finance
trading
models
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
## 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "tks-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/14/ca/ce22a0bc1b49e3834ac35963a2d1c7e755bb7cae2049b7147b4eba49dc73/tks_essentials-0.1.19.tar.gz",
"platform": null,
"description": "# tks-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 tks-essentials`\n\nImport in modules without the dash (e.g.): `from tksessentials.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### Testing\nBefore 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. \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\n## Releasing a new version / CICD Process\n\nThis is entirely executed with Github Actions.\n\nVisual Studio Code --> GitHub Actions --> Build within Github Actions --> Uploaded by Github Actions to pypi.org.\n",
"bugtrack_url": null,
"license": null,
"summary": "Essentials for our TKS projects.",
"version": "0.1.19",
"project_urls": {
"Homepage": "https://github.com/The-Kara-System/tks-essentials"
},
"split_keywords": [
"finance",
" trading",
" models"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8b16bbbf1cbc3287820e1b34f587bcad88968bc0e501aa6f9e752c7b4971e560",
"md5": "ebe9bf2930a2eaab689870d0a3e4a3b2",
"sha256": "53c5d44815693db409f958017e3e3575d4b13c618aea30975c083f2296a04d54"
},
"downloads": -1,
"filename": "tks_essentials-0.1.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebe9bf2930a2eaab689870d0a3e4a3b2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13580,
"upload_time": "2024-11-20T14:20:43",
"upload_time_iso_8601": "2024-11-20T14:20:43.865226Z",
"url": "https://files.pythonhosted.org/packages/8b/16/bbbf1cbc3287820e1b34f587bcad88968bc0e501aa6f9e752c7b4971e560/tks_essentials-0.1.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "14cace22a0bc1b49e3834ac35963a2d1c7e755bb7cae2049b7147b4eba49dc73",
"md5": "9a030647caf1478cabe3e24f1085ca80",
"sha256": "839e1fec42b42a7661a4ae24286b03eda4dcc2abce1dc20383ac5ac87ff5fb2e"
},
"downloads": -1,
"filename": "tks_essentials-0.1.19.tar.gz",
"has_sig": false,
"md5_digest": "9a030647caf1478cabe3e24f1085ca80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 18263,
"upload_time": "2024-11-20T14:20:45",
"upload_time_iso_8601": "2024-11-20T14:20:45.039828Z",
"url": "https://files.pythonhosted.org/packages/14/ca/ce22a0bc1b49e3834ac35963a2d1c7e755bb7cae2049b7147b4eba49dc73/tks_essentials-0.1.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 14:20:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "The-Kara-System",
"github_project": "tks-essentials",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tks-essentials"
}
