| Name | tks-essentials JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | |
| Summary | Essentials for our TKS projects. |
| upload_time | 2024-02-26 08:16:10 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | |
| 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
```
### 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
This is entirely executed with Github Actions.
Raw data
{
"_id": null,
"home_page": "",
"name": "tks-essentials",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "finance,trading,models",
"author": "",
"author_email": "Brayan <brayan@sparkandhale.com>",
"download_url": "https://files.pythonhosted.org/packages/4c/0c/d0e4bfb43d46238d10c51b8c0449b04196673d3bf615611755de28a30165/tks-essentials-0.1.1.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### 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 tks-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\n\nThis is entirely executed with Github Actions.\n",
"bugtrack_url": null,
"license": "",
"summary": "Essentials for our TKS projects.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/The-Kara-System/tks-essentials"
},
"split_keywords": [
"finance",
"trading",
"models"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fc48515061e33f2008fd6774484c63deed2fdb1e4c667ad60c41c8d3ba5c840d",
"md5": "a64f23520a95fef08a78ae1142be0829",
"sha256": "2973ee06ea05b37714a88bc23ab6dacb94973a431fa091e304c115fc94863113"
},
"downloads": -1,
"filename": "tks_essentials-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a64f23520a95fef08a78ae1142be0829",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10257,
"upload_time": "2024-02-26T08:16:09",
"upload_time_iso_8601": "2024-02-26T08:16:09.129969Z",
"url": "https://files.pythonhosted.org/packages/fc/48/515061e33f2008fd6774484c63deed2fdb1e4c667ad60c41c8d3ba5c840d/tks_essentials-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4c0cd0e4bfb43d46238d10c51b8c0449b04196673d3bf615611755de28a30165",
"md5": "4df3e6b01243eaa88c759e54d9a60b40",
"sha256": "b542345f8e57273c9136b3b5aaa64da719211b30e3820b70297e236595756d5a"
},
"downloads": -1,
"filename": "tks-essentials-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "4df3e6b01243eaa88c759e54d9a60b40",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12136,
"upload_time": "2024-02-26T08:16:10",
"upload_time_iso_8601": "2024-02-26T08:16:10.021800Z",
"url": "https://files.pythonhosted.org/packages/4c/0c/d0e4bfb43d46238d10c51b8c0449b04196673d3bf615611755de28a30165/tks-essentials-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 08:16:10",
"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"
}
