-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
42 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,38 +1,42 @@ | ||
| # Find my order | ||
|
|
||
| | <img width="200" alt="Logo" src="https://user-images.githubusercontent.com/8766259/233823991-cceaa05a-ff15-4796-a6bb-bcb3ee0d8859.jpg"> | A python package to identify and <br>parse order for trade execution. | | ||
| | ------------- | ------------- | | ||
| |<br> [](https://talkytrader.gitbook.io/talky/) [](https://pypi.org/project/findmyorder/) <br> <br> [](https://github.com/mraniki/findmyorder/actions/workflows/%F0%9F%91%B7%E2%80%8D%E2%99%82%EF%B8%8FFlow.yml) [](https://codebeat.co/projects/github-com-mraniki-findmyorder-main) [](https://codecov.io/gh/mraniki/findmyorder) | Find & Parse a trade order for execution| | ||
|
|
||
| Key features: | ||
|
|
||
| - Identify an order with word `BUY SELL LONG SHORT` or your own `Bull`, `to the moon`, `pump` via config file | ||
| - Parse and return a structured order with action and instrument as mandatory | ||
| - Capability to map a given instrument to a new one (e.g BTC to WBTC or ETHUSD to ETH) | ||
| - Settings for custom options | ||
|
|
||
| ## Install | ||
|
|
||
| `pip install findmyorder` | ||
|
|
||
| ## How to use it | ||
|
|
||
| ```python | ||
| >>> from findmyorder import FindMyOrder | ||
| fmo = FindMyOrder() | ||
| msg_order = "buy EURUSD sl=1000 tp=1000 q=1 comment=FOMC" | ||
| order = await fmo.get_order(msg_order) | ||
| #{'action': 'BUY', 'instrument': 'EURUSD', 'stop_loss': '1000', 'take_profit': '1000', 'quantity': '2', 'order_type': None, 'leverage_type': None, 'comment': None, 'timestamp': datetime.datetime(2023, 5, 3, 12, 10, 28, 731282, tzinfo=datetime.timezone.utc)} | ||
| ``` | ||
|
|
||
| ### Example | ||
|
|
||
| [example](https://github.com/mraniki/findmyorder/blob/main/examples/example.py) | ||
|
|
||
| ### Real use case | ||
|
|
||
| [TalkyTrader](https://github.com/mraniki/tt) | ||
|
|
||
| ## Documentation | ||
|
|
||
| [](https://talkytrader.gitbook.io/talky/) | ||
| <table style="border: 1px solid transparent"> | ||
| <tr> | ||
| <td> | ||
| <a href="https://talkytrader.github.io/wiki/"><img src="https://img.shields.io/badge/Wiki-%23000000.svg?style=for-the-badge&logo=wikipedia&logoColor=white"></a><br> | ||
| <a href="https://github.com/mraniki/findmyorder/"><img src="https://img.shields.io/badge/github-%23000000.svg?style=for-the-badge&logo=github&logoColor=white"></a> | ||
| <a href="https://hub.docker.com/r/mraniki/tt"><img src="https://img.shields.io/docker/pulls/mraniki/tt?style=for-the-badge"></a><br> | ||
| <a href="https://coindrop.to/mraniki"><img src="https://img.shields.io/badge/tips-000000?style=for-the-badge&logo=buymeacoffee&logoColor=white"></a> | ||
| <a href="https://t.me/TTTalkyTraderChat/1"><img src="https://img.shields.io/badge/talky-blue?style=for-the-badge&logo=telegram&logoColor=white"></a> | ||
| <a href="https://discord.gg/gMNERs5M9"><img src="https://img.shields.io/discord/1049307055867035648?style=for-the-badge&logo=discord&logoColor=white&label=%20%20&color=blue"></a> | ||
| </td> | ||
| <td align="center"><img width="200" alt="Logo" src="https://user-images.githubusercontent.com/8766259/233823991-cceaa05a-ff15-4796-a6bb-bcb3ee0d8859.jpg"></td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <a href="https://pypi.org/project/findmyorder/"><img src="https://img.shields.io/pypi/v/findmyorder?style=for-the-badge&logo=PyPI&logoColor=white"></a><br> | ||
| <a href="https://pypi.org/project/findmyorder/"><img src="https://img.shields.io/pypi/dm/findmyorder?style=for-the-badge&logo=PyPI&logoColor=white"></a><br> | ||
| <a href="https://github.com/mraniki/findmyorder"><img src="https://img.shields.io/github/actions/workflow/status/mraniki/findmyorder/%F0%9F%91%B7%E2%80%8D%E2%99%82%EF%B8%8FFlow.yml?style=for-the-badge&logo=GitHub&logoColor=white"></a><br> | ||
| <a href="https://talkyuniverse.readthedocs.io/projects/fyndmyorder/"><img src="https://readthedocs.org/projects/talkytrend/badge/?version=latest&style=for-the-badge"></a><br> | ||
| <a href="https://codebeat.co/projects/github-com-mraniki-findmyorder-main"><img src="https://codebeat.co/badges/9b113098-d22d-498d-9c61-eb1e96c1311a"/></a><br> | ||
| <a href="https://codecov.io/gh/mraniki/findmyorder"><img src="https://codecov.io/gh/mraniki/findmyorder/branch/main/graph/badge.svg?token=4838MSZNCC"/> </a><br> | ||
| </td> | ||
| <td align="left"> | ||
| Find My order,<br> | ||
| a parsing package to find trading order | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| <h5>How to use it</h5> | ||
| <pre> | ||
| <code> | ||
| from findmyorder import FindMyOrder | ||
| fmo = FindMyOrder() | ||
| msg_order = "buy EURUSD sl=1000 tp=1000 q=1 comment=FOMC" | ||
| order = await fmo.get_order(msg_order) | ||
| #{'action': 'BUY', 'instrument': 'EURUSD', 'stop_loss': '1000', 'take_profit': '1000', 'quantity': '2', 'order_type': None, 'leverage_type': None, 'comment': None, 'timestamp': datetime.datetime(2023, 5, 3, 12, 10, 28, 731282, tzinfo=datetime.timezone.utc)} | ||
| </code> | ||
| </pre> | ||
|
|
||
| <h5>Example</h5> | ||
|
|
||
| https://github.com/mraniki/findmyorder/blob/6211e686abf1321ab3d5a8ac33068f854b0e9336/examples/example.py#L1-L90 |