# HG Systematic
This is a library of utilities and examples to highlight how HGraph can be used to implement
systematic trading strategies.
See [this](https://hgraph.readthedocs.io/en/latest/) for more information.
## Development
The project is currently configured to make use of [Poetry](https://python-poetry.org) for dependency management.
Take a look at the website to see how best to install the tool.
Here are some useful commands:
First, this will cause the virtual environment to be installed in the same folder as the project (in .venv folder)
```bash
poetry config virtualenvs.in-project true
```
Use this command to set the version of Python to make use of if you want a specific version of Python.
```bash
poetry env use 3.12
```
Then use the following command to install the project and its dependencies. Note that the ``--with docs`` installs
the dependencies to build the documentation set which is not required otherwise, also the ``--all-extras`` is only
required for the adaptors.
```bash
poetry install --with docs --all-extras
```
If you did not use the first command, you can find the location of the installation using:
```bash
poetry env info
```
PyCharm can make use of poetry to ``setup`` the project.
### Run Tests
```bash
# No Coverage
poetry run pytest
```
```bash
# Generate Coverage Report
poetry run pytest --cov=your_package_name --cov-report=xml
```
Raw data
{
"_id": null,
"home_page": null,
"name": "hg-systematic",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "reactive, graph, fpg, forward propogating graph, time series, functional reactive programming, frp, functional, time-series, systematic, trading, strategy",
"author": "Howard Henson",
"author_email": "howard@henson.me.uk",
"download_url": "https://files.pythonhosted.org/packages/e8/ff/277e961d4ee2104deee4eca525639e04643552c038fa1742a61f5e8c7d9f/hg_systematic-0.0.3.tar.gz",
"platform": null,
"description": "# HG Systematic\n\nThis is a library of utilities and examples to highlight how HGraph can be used to implement\nsystematic trading strategies.\n\n\nSee [this](https://hgraph.readthedocs.io/en/latest/) for more information.\n\n## Development\n\nThe project is currently configured to make use of [Poetry](https://python-poetry.org) for dependency management. \nTake a look at the website to see how best to install the tool.\n\nHere are some useful commands:\n\nFirst, this will cause the virtual environment to be installed in the same folder as the project (in .venv folder)\n\n```bash\npoetry config virtualenvs.in-project true\n```\n\nUse this command to set the version of Python to make use of if you want a specific version of Python.\n\n```bash\npoetry env use 3.12\n```\n\nThen use the following command to install the project and its dependencies. Note that the ``--with docs`` installs\nthe dependencies to build the documentation set which is not required otherwise, also the ``--all-extras`` is only\nrequired for the adaptors.\n\n```bash\npoetry install --with docs --all-extras\n```\n\nIf you did not use the first command, you can find the location of the installation using:\n\n```bash\npoetry env info\n```\n\nPyCharm can make use of poetry to ``setup`` the project.\n\n### Run Tests\n\n```bash\n# No Coverage\npoetry run pytest\n```\n\n```bash\n# Generate Coverage Report\npoetry run pytest --cov=your_package_name --cov-report=xml\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library and examples to show how HGraph can be used for systematic trading.",
"version": "0.0.3",
"project_urls": {
"Changelog": "https://github.com/hhenson/hg_systematic/blob/main/CHANGELOG.md",
"Documentation": "https://github.com/hhenson/hg_systematic/blob/main/README.md",
"Homepage": "https://github.com/hhenson/hg_systematic",
"Issues": "https://github.com/hhenson/hg_systematic/blob/main/ISSUES.md",
"Repository": "https://github.com/hhenson/hg_systematic.git"
},
"split_keywords": [
"reactive",
" graph",
" fpg",
" forward propogating graph",
" time series",
" functional reactive programming",
" frp",
" functional",
" time-series",
" systematic",
" trading",
" strategy"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b11b8cb7212c2a106e7484a5dfba2b066fefb143ec9178848b3661c989e980cd",
"md5": "c99a447ac34dfc6b96a8da5b64d3f991",
"sha256": "c21dfdaa8b867291dd4a9f1fdd73cb5e30a34d0c03963cada522797e505ea708"
},
"downloads": -1,
"filename": "hg_systematic-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c99a447ac34dfc6b96a8da5b64d3f991",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 4842,
"upload_time": "2024-11-07T18:23:03",
"upload_time_iso_8601": "2024-11-07T18:23:03.450941Z",
"url": "https://files.pythonhosted.org/packages/b1/1b/8cb7212c2a106e7484a5dfba2b066fefb143ec9178848b3661c989e980cd/hg_systematic-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8ff277e961d4ee2104deee4eca525639e04643552c038fa1742a61f5e8c7d9f",
"md5": "ea4173eb3a48e740d016c94511aa5903",
"sha256": "5ab6c526c2057a2c8ca22040e8c9610e80ce556a9daa3e7c532e946f5fc7b6be"
},
"downloads": -1,
"filename": "hg_systematic-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "ea4173eb3a48e740d016c94511aa5903",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 4663,
"upload_time": "2024-11-07T18:23:05",
"upload_time_iso_8601": "2024-11-07T18:23:05.154651Z",
"url": "https://files.pythonhosted.org/packages/e8/ff/277e961d4ee2104deee4eca525639e04643552c038fa1742a61f5e8c7d9f/hg_systematic-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-07 18:23:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hhenson",
"github_project": "hg_systematic",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "hg-systematic"
}
JSON
