| Name | famodels JSON |
| Version |
1.0.20
JSON |
| download |
| home_page | |
| Summary | The library describes the most common models used in trading systems. |
| upload_time | 2023-01-20 15:58:11 |
| 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.
|
# fa-models
A set of models often used for trading services. The library offers no algorithms - just models.
## General
Run and compiled for Python 3.9.13.
## Development
### Installation as Consuming Developer
Simply run:
`pip install fa-models`
### Setup as Contributor
Create the virtul environment: `py -m venv .venv`
Start the Environment: `./.venv/Scripts/activate`. Use `deactivate`to stop it.
Update the PIP: `py -m pip install --upgrade pip`
All the required libraries must be listed in requirements.txt and installed by `py -m pip install -r .\requirements.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
Preqrequisite: 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-models whatever you recommend to improve. Don't forget the Open-Closed Principle: extend only (unless it requires a breaking change)
### Releasing a new version
Install the tools build, twine and bumpver: `python -m pip install build twine bumpver`
Upgrade the setuptools: `pip install --upgrade setuptools`
Delete any old files in the /dist folder.
Bump the version in pyproject.toml: `bumpver update --patch`
Build the project: `python -m build`
Check the distribution: `twine check dist/*`
Upload to test-pypi to validate: `twine upload -r testpypi dist/*`
Login with username: svabra (password should be known)
Finally, upload to pypi production: `twine upload dist/*`
Raw data
{
"_id": null,
"home_page": "",
"name": "famodels",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "finance,trading,models",
"author": "",
"author_email": "Brayan Svan <brayan@freyaalpha.com>",
"download_url": "https://files.pythonhosted.org/packages/39/14/7a0f7d75afd36ef2614cb20be107813d48db578e79dcc7f3283bdb043cee/famodels-1.0.20.tar.gz",
"platform": null,
"description": "# fa-models\r\nA set of models often used for trading services. The library offers no algorithms - just models.\r\n\r\n## General\r\nRun and compiled for Python 3.9.13.\r\n\r\n## Development\r\n\r\n\r\n### Installation as Consuming Developer\r\n\r\nSimply run:\r\n\r\n`pip install fa-models`\r\n\r\n### Setup as Contributor\r\nCreate the virtul environment: `py -m venv .venv`\r\nStart the Environment: `./.venv/Scripts/activate`. Use `deactivate`to stop it.\r\nUpdate the PIP: `py -m pip install --upgrade pip`\r\n\r\nAll the required libraries must be listed in requirements.txt and installed by `py -m pip install -r .\\requirements.txt`\r\n\r\nTo cleanup the environment run:\r\n`pip3 freeze > to-uninstall.txt` and then\r\n`pip3 uninstall -y -r to-uninstall.txt`\r\n\r\nor `pip3 install pip-autoremove`\r\n\r\n### Build Library\r\nPreqrequisite: make sure that you give your Operating System user the right to modify files in the python directory. The directory where pyhton is installed.\r\nUse `python setup.py bdist_wheel` to create the dist, build and .eggs folder.\r\n\r\n## Reference from a different project\r\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-models whatever you recommend to improve. Don't forget the Open-Closed Principle: extend only (unless it requires a breaking change)\r\n\r\n\r\n### Releasing a new version\r\n\r\nInstall the tools build, twine and bumpver: `python -m pip install build twine bumpver`\r\nUpgrade the setuptools: `pip install --upgrade setuptools`\r\n\r\nDelete any old files in the /dist folder.\r\n\r\nBump the version in pyproject.toml: `bumpver update --patch`\r\n\r\nBuild the project: `python -m build`\r\n\r\nCheck the distribution: `twine check dist/*`\r\n\r\nUpload to test-pypi to validate: `twine upload -r testpypi dist/*`\r\n\r\nLogin with username: svabra (password should be known)\r\n\r\nFinally, upload to pypi production: `twine upload dist/*`\r\n\r\n",
"bugtrack_url": null,
"license": "",
"summary": "The library describes the most common models used in trading systems.",
"version": "1.0.20",
"split_keywords": [
"finance",
"trading",
"models"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9d04d1131a808d839cb98aa3bb4a300f9f02fdbd1ae4a7606bc1e1a7132c1b7a",
"md5": "3eb0282e95415246b27aad7dfb3103f9",
"sha256": "97fc0b16104bfeeb51d4a5d922862e515ef8c40139b1db42676e032168b4c38f"
},
"downloads": -1,
"filename": "famodels-1.0.20-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3eb0282e95415246b27aad7dfb3103f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 6169,
"upload_time": "2023-01-20T15:58:10",
"upload_time_iso_8601": "2023-01-20T15:58:10.146764Z",
"url": "https://files.pythonhosted.org/packages/9d/04/d1131a808d839cb98aa3bb4a300f9f02fdbd1ae4a7606bc1e1a7132c1b7a/famodels-1.0.20-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39147a0f7d75afd36ef2614cb20be107813d48db578e79dcc7f3283bdb043cee",
"md5": "d08e5f1425b59b4bfa6a84bda68fb576",
"sha256": "eb88456dbbb14c818687f4172f680f920e4518ec0211ba4e3c2f7a47500ddd2c"
},
"downloads": -1,
"filename": "famodels-1.0.20.tar.gz",
"has_sig": false,
"md5_digest": "d08e5f1425b59b4bfa6a84bda68fb576",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4949,
"upload_time": "2023-01-20T15:58:11",
"upload_time_iso_8601": "2023-01-20T15:58:11.893361Z",
"url": "https://files.pythonhosted.org/packages/39/14/7a0f7d75afd36ef2614cb20be107813d48db578e79dcc7f3283bdb043cee/famodels-1.0.20.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-20 15:58:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "famodels"
}
