# Report Tool 3.0.0-alpha3
[![Latest GitHub release][latest-release]][latest-release-url]
![Latest GitHub pre-release][latest-prerelease]
Report Tool is an application coded in Python 3.11 / PyQt5 using IG Rest API to show basics statistics about past trades.
## Features
* Listing of past trades,
* Summary in points, points per lot, currency or percentage
* Equity curves,
* Export of trades in .txt format or .jpeg format
* Trades comment,
* Market filter.
![Main interface][gui-main-window]
## Installation
### What you will need
* Python 3.11: https://www.python.org/downloads/
* pip (should already be installed with Python): https://pip.pypa.io/en/stable/installing/
* poetry: `curl -sSL https://install.python-poetry.org | python3 -`
* More info: https://python-poetry.org/docs/#installing-with-the-official-installer
### Dependencies
```shell script
cd Report-Tool
poetry install
```
## Usage
* Download the archive and unzip it:
* Either run the entry point:
```shell script
cd Report-Tool
poetry run report-tool
```
* Or run the script:
```shell script
cd Report-Tool
poetry run python -m report_tool
```
* Enter your credentials, via the menu "Connect"
![Connect menu][gui-connect-menu]
* Have fun !
## Building the msi installer
```shell script
cd Report-Tool
poetry run python setup.py bdist_msi
```
## Disclaimer
This tool was originally created by user **beniSo**, but he's no longer on GitHub.
[latest-prerelease]: https://img.shields.io/github/v/release/Mulugruntz/Report-Tool?include_prereleases&label=Report%20Tool
[latest-release]: https://img.shields.io/github/v/release/Mulugruntz/Report-Tool?label=Report%20Tool
[latest-release-url]: https://github.com/Mulugruntz/Report-Tool/releases/latest
[gui-main-window]: https://github.com/Mulugruntz/Report-Tool/raw/master/docs/main.png
[gui-connect-menu]: https://github.com/Mulugruntz/Report-Tool/raw/master/docs/connect.png
Raw data
{
"_id": null,
"home_page": "https://github.com/Mulugruntz/Report-Tool",
"name": "report-tool",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11,<4.0",
"maintainer_email": "",
"keywords": "report,tool,trading,ig,lightstreamer,statistics,trades,positions",
"author": "Samuel Giffard",
"author_email": "samuel@giffard.co",
"download_url": "https://files.pythonhosted.org/packages/d6/0d/abd422e13d50c776468310aa4294a45631b93b1e0e668a446735c30a1fca/report_tool-3.0.0a3.tar.gz",
"platform": null,
"description": "# Report Tool 3.0.0-alpha3\n\n[![Latest GitHub release][latest-release]][latest-release-url]\n![Latest GitHub pre-release][latest-prerelease]\n\nReport Tool is an application coded in Python 3.11 / PyQt5 using IG Rest API to show basics statistics about past trades.\n\n## Features\n\n* Listing of past trades,\n* Summary in points, points per lot, currency or percentage\n* Equity curves,\n* Export of trades in .txt format or .jpeg format\n* Trades comment,\n* Market filter.\n\n![Main interface][gui-main-window]\n\n## Installation\n\n### What you will need\n\n* Python 3.11: https://www.python.org/downloads/\n* pip (should already be installed with Python): https://pip.pypa.io/en/stable/installing/\n* poetry: `curl -sSL https://install.python-poetry.org | python3 -`\n * More info: https://python-poetry.org/docs/#installing-with-the-official-installer\n\n### Dependencies\n\n```shell script\ncd Report-Tool\npoetry install\n```\n\n## Usage\n\n* Download the archive and unzip it:\n* Either run the entry point:\n```shell script\ncd Report-Tool\npoetry run report-tool\n```\n* Or run the script:\n```shell script\ncd Report-Tool\npoetry run python -m report_tool\n```\n* Enter your credentials, via the menu \"Connect\"\n\n![Connect menu][gui-connect-menu]\n\n* Have fun !\n\n## Building the msi installer\n\n```shell script\ncd Report-Tool\npoetry run python setup.py bdist_msi\n```\n\n## Disclaimer\n\nThis tool was originally created by user **beniSo**, but he's no longer on GitHub.\n\n\n[latest-prerelease]: https://img.shields.io/github/v/release/Mulugruntz/Report-Tool?include_prereleases&label=Report%20Tool\n[latest-release]: https://img.shields.io/github/v/release/Mulugruntz/Report-Tool?label=Report%20Tool\n[latest-release-url]: https://github.com/Mulugruntz/Report-Tool/releases/latest\n\n[gui-main-window]: https://github.com/Mulugruntz/Report-Tool/raw/master/docs/main.png\n[gui-connect-menu]: https://github.com/Mulugruntz/Report-Tool/raw/master/docs/connect.png\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Report Tool is an application that uses IG Rest API to show basic statistics about past trades.",
"version": "3.0.0a3",
"split_keywords": [
"report",
"tool",
"trading",
"ig",
"lightstreamer",
"statistics",
"trades",
"positions"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a6d937d37bc3ae00fb67c31514d80b9e21ed394547a7673d0d6c26d74f1353d4",
"md5": "be70b21ac693eb5a40446d52c0964dc7",
"sha256": "8d626d636799468fad5d72ceb85341b59a8e56d30d2d32c209de6fc24cc14c60"
},
"downloads": -1,
"filename": "report_tool-3.0.0a3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "be70b21ac693eb5a40446d52c0964dc7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11,<4.0",
"size": 91551,
"upload_time": "2023-04-10T18:02:59",
"upload_time_iso_8601": "2023-04-10T18:02:59.948900Z",
"url": "https://files.pythonhosted.org/packages/a6/d9/37d37bc3ae00fb67c31514d80b9e21ed394547a7673d0d6c26d74f1353d4/report_tool-3.0.0a3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d60dabd422e13d50c776468310aa4294a45631b93b1e0e668a446735c30a1fca",
"md5": "2ec7f10b321671ab10719f2282c55afa",
"sha256": "141687dbcc8cc607efee288ba57e8153bc1fecc820d2a0a487a149d8d55a48c6"
},
"downloads": -1,
"filename": "report_tool-3.0.0a3.tar.gz",
"has_sig": false,
"md5_digest": "2ec7f10b321671ab10719f2282c55afa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11,<4.0",
"size": 82127,
"upload_time": "2023-04-10T18:03:01",
"upload_time_iso_8601": "2023-04-10T18:03:01.838104Z",
"url": "https://files.pythonhosted.org/packages/d6/0d/abd422e13d50c776468310aa4294a45631b93b1e0e668a446735c30a1fca/report_tool-3.0.0a3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-10 18:03:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Mulugruntz",
"github_project": "Report-Tool",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "report-tool"
}
JSON
