# Pyrobot
## Table of Contents
- [Overview](#overview)
- [Setup](#setup)
- [Usage](#usage)
## Overview
Current Version: **1.0.6**
A trading robot written in Python utilizing the [Lemon Markets API](https://www.lemon.markets/) designed to mimic a few common scenarios:
1. Providing an interface for the user's trading account. The `PyRobot` object will initialize a new instance of the robot and provide general information regarding the user's account. It will also serve as main object connecting all other objects to provide easy access to other functionalities.
2. Maintaining a portfolio of multiple instruments. The `Portfolio` object will be able
to calculate common portfolio risk metrics, display order information, and provide both historical and real-time prices for instruments.
3. Define an order that can be used to trade a financial instrument. With the `Trade` object, you can place, cancel and retrieve orders.
4. Define and calculate indicators using both historical and real-time prices. The `Indicator` object
will help you easily define the input of your indicators, calculate them, and then update their values
as new prices come.
5. Access new information daily. The `MarketData`,`TradingPositions` and `TradingAccount` objects will interact with the [Lemon Markets API](https://www.lemon.markets/) to ensure the trader is equipped with up-to-date information regarding the market and their portfolio.
## Setup
**Setup - PyPi Install:**
The project can be found at PyPI, if you'd like to view the project please use this
[link](https://pypi.org/project/trad-robo-python/). To **install** the library,
run the following command from the terminal.
```bash
pip install trad-robo-python
```
## Usage
To run the robot, you will need to provide a few pieces of information from your Lemon Markets Paper Trading Account
The following items are need for authentication:
- Market Data API Key: This will be provided when you register an account with the Lemon Markets website. An example of a Market Data API key could look like the following `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJh`.
- Paper Trading API Key: This will be provided when you register an account with the Lemon Markets website. An example of a Paper Trading API key could look like the following `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.`.
Once you've identified those pieces of info, you can run the robot. Here is a simple example that will create a new instance
of it:
```python
from pyrobot.robot import PyRobot
# Initialize the robot
trading_robot = PyRobot(
market_api_key='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJh',
paper-trading_api_key='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.'
)
```
For more detailed examples, go to the [`run_robot.py`](https://github.com/mh2rashi/Pyrobot/blob/main/run_robot.py) file to see an example of how to use the library along with all the different objects inside.
Raw data
{
"_id": null,
"home_page": "https://github.com/mh2rashi/Trad-Robo-Python",
"name": "trad-robo-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "finance,lemon markets,api,trading robot",
"author": "Hamza Rashid",
"author_email": "hamza022697@gmail.com",
"download_url": "",
"platform": null,
"description": "# Pyrobot\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Setup](#setup)\n- [Usage](#usage)\n\n\n## Overview\n\nCurrent Version: **1.0.6**\n\nA trading robot written in Python utilizing the [Lemon Markets API](https://www.lemon.markets/) designed to mimic a few common scenarios: \n\n\n1. Providing an interface for the user's trading account. The `PyRobot` object will initialize a new instance of the robot and provide general information regarding the user's account. It will also serve as main object connecting all other objects to provide easy access to other functionalities.\n\n2. Maintaining a portfolio of multiple instruments. The `Portfolio` object will be able\n to calculate common portfolio risk metrics, display order information, and provide both historical and real-time prices for instruments.\n\n3. Define an order that can be used to trade a financial instrument. With the `Trade` object, you can place, cancel and retrieve orders.\n\n4. Define and calculate indicators using both historical and real-time prices. The `Indicator` object\n will help you easily define the input of your indicators, calculate them, and then update their values\n as new prices come.\n\n5. Access new information daily. The `MarketData`,`TradingPositions` and `TradingAccount` objects will interact with the [Lemon Markets API](https://www.lemon.markets/) to ensure the trader is equipped with up-to-date information regarding the market and their portfolio.\n\n## Setup\n\n**Setup - PyPi Install:**\n\nThe project can be found at PyPI, if you'd like to view the project please use this\n[link](https://pypi.org/project/trad-robo-python/). To **install** the library,\nrun the following command from the terminal.\n\n```bash\npip install trad-robo-python\n```\n\n\n## Usage\n\nTo run the robot, you will need to provide a few pieces of information from your Lemon Markets Paper Trading Account\nThe following items are need for authentication:\n\n- Market Data API Key: This will be provided when you register an account with the Lemon Markets website. An example of a Market Data API key could look like the following `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJh`.\n\n- Paper Trading API Key: This will be provided when you register an account with the Lemon Markets website. An example of a Paper Trading API key could look like the following `eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.`.\n\n\n\nOnce you've identified those pieces of info, you can run the robot. Here is a simple example that will create a new instance\nof it:\n\n```python\nfrom pyrobot.robot import PyRobot\n\n# Initialize the robot\ntrading_robot = PyRobot(\n market_api_key='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJh',\n paper-trading_api_key='eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.'\n)\n```\n\nFor more detailed examples, go to the [`run_robot.py`](https://github.com/mh2rashi/Pyrobot/blob/main/run_robot.py) file to see an example of how to use the library along with all the different objects inside.\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "A trading robot written in Python utilizing the Lemon Markets API capable of maintaining a portfolio of instruments, displaying performance metrics, submitting orders, providing real-time & historical data and showcasing technical indicators.",
"version": "1.0.6",
"split_keywords": [
"finance",
"lemon markets",
"api",
"trading robot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76f3226885dc031b37a67f34b24c79ebfce3e320342e82c2d203dd1aa4ca5b98",
"md5": "d631a318eed35bb5b05071c8094283f9",
"sha256": "f4f9266677ad6352be592e604d38a4e92475d3816f67c91e906c962b5ccedebe"
},
"downloads": -1,
"filename": "trad_robo_python-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d631a318eed35bb5b05071c8094283f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 24586,
"upload_time": "2023-01-31T01:01:37",
"upload_time_iso_8601": "2023-01-31T01:01:37.397314Z",
"url": "https://files.pythonhosted.org/packages/76/f3/226885dc031b37a67f34b24c79ebfce3e320342e82c2d203dd1aa4ca5b98/trad_robo_python-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-31 01:01:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mh2rashi",
"github_project": "Trad-Robo-Python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "trad-robo-python"
}
JSON
