[![Static Badge](https://img.shields.io/badge/Documentation-blue)](https://dodid.github.io/minitrade/)
[![Build Status](https://img.shields.io/github/actions/workflow/status/dodid/minitrade/test_code.yml?branch=main)](https://github.com/dodid/minitrade/actions)
[![Backtesting on PyPI](https://img.shields.io/pypi/v/minitrade.svg?color=blue)](https://pypi.org/project/minitrade)
[![PyPI downloads](https://img.shields.io/pypi/dm/minitrade.svg?color=skyblue)](https://pypi.org/project/minitrade)
# Minitrade - Simplifying Personal Trading
**Minitrade** is a personal trading system that combines strategy backtesting and automated order execution. Leveraging the power of [Backtesting.py](https://github.com/kernc/backtesting.py), Minitrade offers an array of enhanced features:
- **Multi-asset rebalance strategy backtest**: Explore and optimize your trading strategies across various assets.
- Automated strategy execution and order submission: Seamlessly execute your trading strategies and submit orders automatically.
- Web-based management UI: Access a user-friendly web interface to manage and monitor your trading activities.
- Streamlined mobile notifications and control: Stay informed and in control with mobile notifications for important trading events.
With Minitrade, setting up your private and fully automated stock trading system is easy and affordable.
## Installation
$ pip install minitrade
$ minitrade init
Minitrade requires `python >= 3.10`. **Rerun `"minitrade init"` after every Minitrade upgrade.** For detailed installation instructions, refer to the [Installation](https://dodid.github.io/minitrade/install/) section on the website.
## Usage
### Backtesting
| ![Minitrade backtesting](<https://imgur.com/plaomF0.png>) |
| ------------------------------------------------------- |
### Trading
| ![Minitrade web UI - history](<https://imgur.com/ittnlk7.png>) |
| -------------------------------------------------------------- |
| ![Minitrade web UI - orders](<https://imgur.com/2DAZ2W1.png>) |
See more in [Documentation](https://dodid.github.io/minitrade/).
## Limitations
Please be aware of the following limitations:
- Multi-asset strategies currently support long positions and market orders only.
- Linux and Mac platforms are currently supported.
- Daily bar data is currently supported.
- Interactive Brokers is the supported broker.
## Contributing
Check out the guidelines on [how to contribute](CONTRIBUTING.md) to the project. Or **star** the project so others can find it!
[![Stargazers over time](https://starchart.cc/dodid/minitrade.svg?variant=adaptive)](https://starchart.cc/dodid/minitrade)
## License
[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html)
Raw data
{
"_id": null,
"home_page": "https://dodid.github.io/minitrade/",
"name": "minitrade",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "finance, investing, trading, algorithmic-trading, backtesting, backtesting-frameworks, interactive-brokers",
"author": "Wei Wu",
"author_email": "dodid@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/b7/d3/d5af6e0b5b45c5f6f9291b46569c2f096e23bfdfabd05d5d56ace33af22c/minitrade-0.1.39.tar.gz",
"platform": null,
"description": "[![Static Badge](https://img.shields.io/badge/Documentation-blue)](https://dodid.github.io/minitrade/)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/dodid/minitrade/test_code.yml?branch=main)](https://github.com/dodid/minitrade/actions)\n[![Backtesting on PyPI](https://img.shields.io/pypi/v/minitrade.svg?color=blue)](https://pypi.org/project/minitrade)\n[![PyPI downloads](https://img.shields.io/pypi/dm/minitrade.svg?color=skyblue)](https://pypi.org/project/minitrade)\n\n\n# Minitrade - Simplifying Personal Trading\n\n**Minitrade** is a personal trading system that combines strategy backtesting and automated order execution. Leveraging the power of [Backtesting.py](https://github.com/kernc/backtesting.py), Minitrade offers an array of enhanced features:\n\n- **Multi-asset rebalance strategy backtest**: Explore and optimize your trading strategies across various assets.\n- Automated strategy execution and order submission: Seamlessly execute your trading strategies and submit orders automatically.\n- Web-based management UI: Access a user-friendly web interface to manage and monitor your trading activities.\n- Streamlined mobile notifications and control: Stay informed and in control with mobile notifications for important trading events.\n\nWith Minitrade, setting up your private and fully automated stock trading system is easy and affordable.\n\n## Installation\n\n $ pip install minitrade\n $ minitrade init\n\nMinitrade requires `python >= 3.10`. **Rerun `\"minitrade init\"` after every Minitrade upgrade.** For detailed installation instructions, refer to the [Installation](https://dodid.github.io/minitrade/install/) section on the website.\n\n## Usage\n\n### Backtesting\n\n| ![Minitrade backtesting](<https://imgur.com/plaomF0.png>) |\n| ------------------------------------------------------- |\n\n### Trading\n\n| ![Minitrade web UI - history](<https://imgur.com/ittnlk7.png>) |\n| -------------------------------------------------------------- |\n| ![Minitrade web UI - orders](<https://imgur.com/2DAZ2W1.png>) |\n\nSee more in [Documentation](https://dodid.github.io/minitrade/).\n\n## Limitations\n\nPlease be aware of the following limitations:\n\n- Multi-asset strategies currently support long positions and market orders only.\n- Linux and Mac platforms are currently supported.\n- Daily bar data is currently supported.\n- Interactive Brokers is the supported broker.\n\n## Contributing\n\nCheck out the guidelines on [how to contribute](CONTRIBUTING.md) to the project. Or **star** the project so others can find it!\n\n[![Stargazers over time](https://starchart.cc/dodid/minitrade.svg?variant=adaptive)](https://starchart.cc/dodid/minitrade)\n\n\n## License\n\n[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.en.html)\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "A personal automated trading system",
"version": "0.1.39",
"project_urls": {
"Homepage": "https://dodid.github.io/minitrade/",
"Repository": "https://github.com/dodid/minitrade"
},
"split_keywords": [
"finance",
" investing",
" trading",
" algorithmic-trading",
" backtesting",
" backtesting-frameworks",
" interactive-brokers"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d949d30311e5537daba595d8857e887929ed7db3120e916b46230181ddace90",
"md5": "d5750f1ce43eb2d6fad30998b51080c2",
"sha256": "b1369544c368ee7437763528d7753870951e0da1e80605a745473d9f4682b098"
},
"downloads": -1,
"filename": "minitrade-0.1.39-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5750f1ce43eb2d6fad30998b51080c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 270806,
"upload_time": "2024-04-15T03:44:54",
"upload_time_iso_8601": "2024-04-15T03:44:54.493490Z",
"url": "https://files.pythonhosted.org/packages/3d/94/9d30311e5537daba595d8857e887929ed7db3120e916b46230181ddace90/minitrade-0.1.39-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7d3d5af6e0b5b45c5f6f9291b46569c2f096e23bfdfabd05d5d56ace33af22c",
"md5": "976df88712249a82cf326c32aa8aa72f",
"sha256": "8269b2ab8c1d0cc26d46f60e6649544038b099d29d77ff67e2b860f0db0e214f"
},
"downloads": -1,
"filename": "minitrade-0.1.39.tar.gz",
"has_sig": false,
"md5_digest": "976df88712249a82cf326c32aa8aa72f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 250523,
"upload_time": "2024-04-15T03:44:56",
"upload_time_iso_8601": "2024-04-15T03:44:56.577026Z",
"url": "https://files.pythonhosted.org/packages/b7/d3/d5af6e0b5b45c5f6f9291b46569c2f096e23bfdfabd05d5d56ace33af22c/minitrade-0.1.39.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-15 03:44:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dodid",
"github_project": "minitrade",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "minitrade"
}