<div align="center">
[](https://plutuss-organization.gitbook.io/documentation/)
<img src="./assets/plutus_icon_full.png" height="400px" alt="Plutus Terminal Splash Screen"/>
# Plutus Terminal
</div>
## What is Plutus Terminal? 🌟
<p align="center">
<img src="./assets/plutus_splash.gif" alt="Plutus Terminal Splash Screen"/>
</p>
Plutus Terminal is a powerful **open-source** crypto news trading terminal
focused on Perpetuals DEX. Designed to be user-friendly, it allows you to trade
using real-time news updates, control positions, and manage multiple DEXs.
Embracing the web3 mentality, Plutus Terminal ensures you are always in control
of your keys, handles everything locally, and interacts directly with the DEX
contracts.
## Features 🎯
- 💻 Runs locally on your computer
- 🌐 Cross-platform (Windows, Linux, MacOS)
- 🔄 Integrates TreeOfAlpha and PhoenixNews
- 🛠️ Highly customizable news filters
- 🔔 Never miss news with desktop notifications
- 💎 Open-source and free
- 🌍 Use your own RPC nodes
## ⚠️ Disclaimer
Plutus Terminal is in **alpha** version and it's more likely to break. It
trades on the Perpetuals DEX using real money. Do not risk money you cannot
afford to lose.
**PLUTUS TERMINAL IS PROVIDED "AS IS". USE THE SOFTWARE AT YOUR OWN RISK**. The
authors and all affiliates assume no responsibility for your trading results or
any other consequences arising from the use of this tool. The entire risk as to
the quality and performance of the program is with you. Should the program
prove defective, you assume the cost of all necessary servicing, repair, or
correction.
By using Plutus Terminal, you acknowledge and agree that:
* You understand the risks involved in trading cryptocurrencies.
* You will not hold the authors or affiliates liable for any financial losses, data breaches, or other damages.
* You have read and understood the source code before using the tool.
* Positions opened with Plutus Terminal will automatically use our referral codes when possible.
Plutus Terminal is for educational and informational purposes only and does not constitute financial advice.
## 🛠️ Installation
Plutus Terminal is a Python package with multiple dependencies. You can install
it by downloading the PyApp executable, using pipx, or building it with Poetry.
<details>
<summary>
<strong>Installation using <code>PyApp executable</code>:</strong>
</summary>
### PyApp
#### To install
Download the plutus-terminal executable from the [Releases page](https://github.com/plutus-terminal/plutus-terminal/releases) and run it directly.
#### To update
From the terminal run:
```bash
<plutus_terminal_executable> self update
```
#### To uninstall
```bash
<plutus_terminal_executable> self remove
```
> [!NOTE]
> To learn more about PyApp, check out the [PyApp documentation](https://ofek.dev/pyapp/latest/)
<br>
</details>
<br>
<details>
<summary>
<strong>Installation using <code>pipx</code>:</strong>
</summary>
<br>
### Pipx
#### To install
```bash
pipx install plutus-terminal
```
Run with:
```bash
plutus-terminal
```
#### To update
```bash
pipx upgrade plutus-terminal
```
</details>
<br>
<details>
<summary>
<strong>Installation using <code>Poetry</code>:</strong>
</summary>
<br>
### Poetry
#### To install
First, clone the repository:
```bash
git clone https://github.com/plutus-terminal/plutus-terminal.git
```
Navigate to the cloned repository:
```bash
cd plutus-terminal
```
Checkout the `main` branch:
```bash
git checkout main
```
Then, install the package:
```bash
poetry install
```
Run the tool with:
```bash
poetry run plutus-terminal
```
#### To update
```bash
git pull
poetry update
```
</details>
## 🚀 Quick Start
Bellow you will find a simple guide on how to get started with Plutus Terminal.
For a more complete documentation please refer to the
[documentation](https://plutuss-organization.gitbook.io/documentation)
### Create new account
When opening the terminal the first time, you will be prompted to create an account.
<details>
<summary>
See image...
</summary>
<div align="center">
<img src="./assets/create_new_acc.png" alt="Create Account"/>
</div>
<br>
> [!NOTE]
> The same private key can be used to create multiple accounts on different
> exchanges.
</details>
<br>
Fill the form with the required information and press `Create New Account`.
> [!CAUTION]
> The private key will be stored in the OS keyring, always ensure
> your OS is secure.
### News quick market buy
Once the account is created you should see the terminal opening after a couple
of seconds.
News will be presented in real-time under the `News Feed` widget, if the coins
associated with the news are available on the selected exchange you will see a
quick trade group appear on the news.
<details>
<summary>
See image...
</summary>
<br>
<div align="center">
<img src="./assets/news_example.png" alt="News with quick buy trades."/>
</div>
</details>
<br>
> [!NOTE]
> `Quick Market Buy` values represent the amount of capital that will be used
> to open your position. This value get's multiplied by the current pair
> leverage to determine the size of the position.
### Auto TP/SL
Quick Market buys can be configured with `TP` and `SL` values. For that you
will need to open the configuration window by pressing the gear icon on the top
right corner.
Once the window is open, you can set the `TP` and `SL` values on the `Trade` tab.
<details>
<summary>
See image...
</summary>
<br>
<div align="center">
<img src="./assets/auto_tp_sl_config.gif" alt="Auto TP/SL"/>
</div>
</details>
<br>
> [!NOTE]
> Each account have their own `TP` and `SL` values
### News Filters
You can configure the news filters by clicking on the `Filters` tab in the
configuration window.
There are 2 types of filters `Keyword Matching` and `Data Matching`. Both of
them allow actions to happen when the conditions are meet.
Posible actions are:
| Action | Description |
| ----------------- | ---------------------------- |
| Sound Association | Play a specific sound |
| Coin Association | Associate a coin to the news |
| Ignore News | Don't display the news |
#### Keyword Matching
The `Keyword Matching` filter allows you to filter specific keywords in the
news body if the keyword is present the selected action will run on the news.
<details>
<summary>
Example
</summary>
<br>
<div align="center">
<img src="./assets/keyword_matching.png" alt="Keyword Matching"/>
</div>
This filter will play the `pause` sound if the word `Foxify` is present in the
news body and it will color that word dark pink.
</details>
#### Data Matching
The `Data Matching` filter allows you to filter for word on specific data
fields if the word is present in the specified datafield then the selected
action will run on the news.
<details>
<summary>
Example
</summary>
<br>
<div align="center">
<img src="./assets/data_matching.png" alt="Data Matching"/>
</div>
This filter will play the `powerup` sound if the title of the news is `Tree News (@News_Of_Alpha)`
</details>
<br>
> [!NOTE]
> Filters will only be saved if the `Save Filters` button is pressed and
> will only be applied after a restart.
#### Hotkey Shortcuts
| Hotkey | Action |
| ------------------ | ------------------------------------------------------------- |
| `w` | Move selected new 1 up |
| `s` | Move selected new 1 down |
| `q` | Move selected to the top |
| `\` | Open token modal search |
| `Ctrl+j` or `UP` | (Only on modal search) Move modal auto complete selection down |
| `Ctrl+k` or `DOWN` | (Only on modal search) Move modal auto complete selection down |
## 🌐 Exchanges
Current supported exchanges are:
* <img src="./assets/foxify.svg" height="25px" alt="Foxify Logo"/> [Foxify](https://perp.foxify.trade/#/trade/?ref=plutus_terminal)
* <img src="./assets/foxify.svg" height="25px" alt="Foxify Logo"/> [Foxify FUNDED](https://foxify-1.gitbook.io/foxify-funded-litepaper)
Planned support:
* <img src="./assets/gmx.svg" height="25px" alt="Foxify Logo"/> [GMX](https://app.gmx.io/#/trade/?ref=plutus_terminal)
## ❤️ Support
If this project was helpful, please consider supporting by:
* ⭐[Starring the project on GitHub](https://github.com/plutus-terminal/plutus-terminal)
* Use referral code `plutus_terminal`
* Make a donation:
* EVM ADDRESS: 0x92E3E69597A81c9D8F131FD590E8028aD16d1155
Every bit helps. Thank you!
## 📜 License
Plutus Terminal is licensed under the `GNU General Public License version 3.0`
See [LICENSE](./LICENSE) for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/plutus-terminal/plutus-terminal",
"name": "plutus-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.12",
"maintainer_email": null,
"keywords": "plutus, terminal, crypto, trading, trading-bot, perpetuals, dex",
"author": "Plutus",
"author_email": "plutus-terminal@protonmail.com",
"download_url": "https://files.pythonhosted.org/packages/d1/b3/04bc7d529a60948a5b54ddbb94229bb11129f816dcac4c883a0089c93e6a/plutus_terminal-0.1.0b3.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n\n\n[](https://plutuss-organization.gitbook.io/documentation/)\n\n\n<img src=\"./assets/plutus_icon_full.png\" height=\"400px\" alt=\"Plutus Terminal Splash Screen\"/>\n\n# Plutus Terminal\n</div>\n\n## What is Plutus Terminal? \ud83c\udf1f\n\n<p align=\"center\">\n <img src=\"./assets/plutus_splash.gif\" alt=\"Plutus Terminal Splash Screen\"/>\n</p>\n\nPlutus Terminal is a powerful **open-source** crypto news trading terminal\nfocused on Perpetuals DEX. Designed to be user-friendly, it allows you to trade\nusing real-time news updates, control positions, and manage multiple DEXs.\n\nEmbracing the web3 mentality, Plutus Terminal ensures you are always in control\nof your keys, handles everything locally, and interacts directly with the DEX\ncontracts.\n\n## Features \ud83c\udfaf\n\n- \ud83d\udcbb Runs locally on your computer\n- \ud83c\udf10 Cross-platform (Windows, Linux, MacOS)\n- \ud83d\udd04 Integrates TreeOfAlpha and PhoenixNews\n- \ud83d\udee0\ufe0f Highly customizable news filters\n- \ud83d\udd14 Never miss news with desktop notifications\n- \ud83d\udc8e Open-source and free\n- \ud83c\udf0d Use your own RPC nodes\n\n## \u26a0\ufe0f Disclaimer\n\nPlutus Terminal is in **alpha** version and it's more likely to break. It\ntrades on the Perpetuals DEX using real money. Do not risk money you cannot\nafford to lose.\n\n**PLUTUS TERMINAL IS PROVIDED \"AS IS\". USE THE SOFTWARE AT YOUR OWN RISK**. The\nauthors and all affiliates assume no responsibility for your trading results or\nany other consequences arising from the use of this tool. The entire risk as to\nthe quality and performance of the program is with you. Should the program\nprove defective, you assume the cost of all necessary servicing, repair, or\ncorrection.\n\nBy using Plutus Terminal, you acknowledge and agree that:\n\n* You understand the risks involved in trading cryptocurrencies.\n* You will not hold the authors or affiliates liable for any financial losses, data breaches, or other damages.\n* You have read and understood the source code before using the tool.\n* Positions opened with Plutus Terminal will automatically use our referral codes when possible.\n\nPlutus Terminal is for educational and informational purposes only and does not constitute financial advice.\n\n## \ud83d\udee0\ufe0f Installation\n\nPlutus Terminal is a Python package with multiple dependencies. You can install\nit by downloading the PyApp executable, using pipx, or building it with Poetry.\n\n<details>\n<summary>\n<strong>Installation using <code>PyApp executable</code>:</strong>\n</summary>\n\n### PyApp\n\n#### To install\n\nDownload the plutus-terminal executable from the [Releases page](https://github.com/plutus-terminal/plutus-terminal/releases) and run it directly.\n\n#### To update\n\nFrom the terminal run:\n\n```bash\n<plutus_terminal_executable> self update\n```\n\n#### To uninstall\n\n```bash\n<plutus_terminal_executable> self remove\n```\n\n> [!NOTE]\n> To learn more about PyApp, check out the [PyApp documentation](https://ofek.dev/pyapp/latest/)\n\n<br>\n</details>\n<br>\n\n<details>\n<summary>\n<strong>Installation using <code>pipx</code>:</strong>\n</summary>\n\n<br>\n\n### Pipx\n\n#### To install\n\n```bash\npipx install plutus-terminal\n```\n\nRun with:\n\n```bash\nplutus-terminal\n```\n\n#### To update\n\n```bash\npipx upgrade plutus-terminal\n```\n\n</details>\n<br>\n\n<details>\n<summary>\n<strong>Installation using <code>Poetry</code>:</strong>\n</summary>\n<br>\n\n### Poetry\n\n#### To install\n\nFirst, clone the repository:\n\n```bash\ngit clone https://github.com/plutus-terminal/plutus-terminal.git\n```\n\nNavigate to the cloned repository:\n\n```bash\ncd plutus-terminal\n```\n\nCheckout the `main` branch:\n\n```bash\ngit checkout main\n```\n\nThen, install the package:\n\n```bash\npoetry install\n```\n\nRun the tool with:\n\n```bash\npoetry run plutus-terminal\n```\n#### To update\n\n```bash\ngit pull\npoetry update\n```\n\n</details>\n\n## \ud83d\ude80 Quick Start\n\nBellow you will find a simple guide on how to get started with Plutus Terminal.\nFor a more complete documentation please refer to the\n[documentation](https://plutuss-organization.gitbook.io/documentation)\n\n### Create new account\n\nWhen opening the terminal the first time, you will be prompted to create an account.\n<details>\n<summary>\nSee image...\n</summary>\n<div align=\"center\">\n<img src=\"./assets/create_new_acc.png\" alt=\"Create Account\"/>\n</div>\n<br>\n> [!NOTE]\n> The same private key can be used to create multiple accounts on different\n> exchanges.\n</details>\n<br>\n\nFill the form with the required information and press `Create New Account`.\n\n> [!CAUTION]\n> The private key will be stored in the OS keyring, always ensure\n> your OS is secure.\n\n### News quick market buy\n\nOnce the account is created you should see the terminal opening after a couple\nof seconds.\n\nNews will be presented in real-time under the `News Feed` widget, if the coins\nassociated with the news are available on the selected exchange you will see a\nquick trade group appear on the news.\n\n<details>\n<summary>\nSee image...\n</summary>\n<br>\n<div align=\"center\">\n<img src=\"./assets/news_example.png\" alt=\"News with quick buy trades.\"/>\n</div>\n</details>\n<br>\n\n> [!NOTE]\n> `Quick Market Buy` values represent the amount of capital that will be used\n> to open your position. This value get's multiplied by the current pair\n> leverage to determine the size of the position.\n\n### Auto TP/SL\n\nQuick Market buys can be configured with `TP` and `SL` values. For that you\nwill need to open the configuration window by pressing the gear icon on the top\nright corner.\n\nOnce the window is open, you can set the `TP` and `SL` values on the `Trade` tab.\n\n<details>\n<summary>\nSee image...\n</summary>\n<br>\n<div align=\"center\">\n<img src=\"./assets/auto_tp_sl_config.gif\" alt=\"Auto TP/SL\"/>\n</div>\n</details>\n<br>\n\n> [!NOTE]\n> Each account have their own `TP` and `SL` values\n\n### News Filters\n\nYou can configure the news filters by clicking on the `Filters` tab in the\nconfiguration window.\n\nThere are 2 types of filters `Keyword Matching` and `Data Matching`. Both of\nthem allow actions to happen when the conditions are meet.\n\nPosible actions are:\n\n| Action | Description |\n| ----------------- | ---------------------------- |\n| Sound Association | Play a specific sound |\n| Coin Association | Associate a coin to the news |\n| Ignore News | Don't display the news |\n\n#### Keyword Matching\n\nThe `Keyword Matching` filter allows you to filter specific keywords in the\nnews body if the keyword is present the selected action will run on the news.\n\n<details>\n<summary>\nExample\n</summary>\n<br>\n<div align=\"center\">\n<img src=\"./assets/keyword_matching.png\" alt=\"Keyword Matching\"/>\n</div>\nThis filter will play the `pause` sound if the word `Foxify` is present in the\nnews body and it will color that word dark pink.\n</details>\n\n\n#### Data Matching\n\nThe `Data Matching` filter allows you to filter for word on specific data\nfields if the word is present in the specified datafield then the selected\naction will run on the news.\n\n<details>\n<summary>\nExample\n</summary>\n<br>\n<div align=\"center\">\n<img src=\"./assets/data_matching.png\" alt=\"Data Matching\"/>\n</div>\nThis filter will play the `powerup` sound if the title of the news is `Tree News (@News_Of_Alpha)`\n</details>\n<br>\n\n\n> [!NOTE]\n> Filters will only be saved if the `Save Filters` button is pressed and\n> will only be applied after a restart.\n\n#### Hotkey Shortcuts\n\n| Hotkey | Action |\n| ------------------ | ------------------------------------------------------------- |\n| `w` | Move selected new 1 up |\n| `s` | Move selected new 1 down |\n| `q` | Move selected to the top |\n| `\\` | Open token modal search |\n| `Ctrl+j` or `UP` | (Only on modal search) Move modal auto complete selection down |\n| `Ctrl+k` or `DOWN` | (Only on modal search) Move modal auto complete selection down |\n\n\n\n## \ud83c\udf10 Exchanges\n\nCurrent supported exchanges are:\n\n* <img src=\"./assets/foxify.svg\" height=\"25px\" alt=\"Foxify Logo\"/> [Foxify](https://perp.foxify.trade/#/trade/?ref=plutus_terminal)\n* <img src=\"./assets/foxify.svg\" height=\"25px\" alt=\"Foxify Logo\"/> [Foxify FUNDED](https://foxify-1.gitbook.io/foxify-funded-litepaper)\n\nPlanned support:\n\n* <img src=\"./assets/gmx.svg\" height=\"25px\" alt=\"Foxify Logo\"/> [GMX](https://app.gmx.io/#/trade/?ref=plutus_terminal)\n\n## \u2764\ufe0f Support\n\nIf this project was helpful, please consider supporting by:\n\n* \u2b50[Starring the project on GitHub](https://github.com/plutus-terminal/plutus-terminal)\n* Use referral code `plutus_terminal`\n* Make a donation:\n * EVM ADDRESS: 0x92E3E69597A81c9D8F131FD590E8028aD16d1155\n\nEvery bit helps. Thank you!\n\n## \ud83d\udcdc License\n\nPlutus Terminal is licensed under the `GNU General Public License version 3.0`\n\nSee [LICENSE](./LICENSE) for details.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Plutus Terminal is a powerful open-source crypto news trading terminal with the focus on Perpetuals DEX.",
"version": "0.1.0b3",
"project_urls": {
"Homepage": "https://github.com/plutus-terminal/plutus-terminal",
"Repository": "https://github.com/plutus-terminal/plutus-terminal"
},
"split_keywords": [
"plutus",
" terminal",
" crypto",
" trading",
" trading-bot",
" perpetuals",
" dex"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92c938b483ecbdc2f139b9b47deaa39aa000b1dbae4f583d2bfe7444404e9ea4",
"md5": "b7208239cd5758712b525dc9727673a9",
"sha256": "e3c9b70cb19aaada29e15b4c93b8f846e508b17acd4e0d293f6596215561f73d"
},
"downloads": -1,
"filename": "plutus_terminal-0.1.0b3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7208239cd5758712b525dc9727673a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.12",
"size": 6643878,
"upload_time": "2024-11-11T01:19:14",
"upload_time_iso_8601": "2024-11-11T01:19:14.620504Z",
"url": "https://files.pythonhosted.org/packages/92/c9/38b483ecbdc2f139b9b47deaa39aa000b1dbae4f583d2bfe7444404e9ea4/plutus_terminal-0.1.0b3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d1b304bc7d529a60948a5b54ddbb94229bb11129f816dcac4c883a0089c93e6a",
"md5": "3509820774c8cd7a99d2d70189a1cbcc",
"sha256": "9f4b2a05911512b2cf9b7d3c9d2f99a94034e7d83e36de0aa091fdd21b89975f"
},
"downloads": -1,
"filename": "plutus_terminal-0.1.0b3.tar.gz",
"has_sig": false,
"md5_digest": "3509820774c8cd7a99d2d70189a1cbcc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.12",
"size": 6537433,
"upload_time": "2024-11-11T01:19:16",
"upload_time_iso_8601": "2024-11-11T01:19:16.921424Z",
"url": "https://files.pythonhosted.org/packages/d1/b3/04bc7d529a60948a5b54ddbb94229bb11129f816dcac4c883a0089c93e6a/plutus_terminal-0.1.0b3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-11 01:19:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "plutus-terminal",
"github_project": "plutus-terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "plutus-terminal"
}
JSON
