| Name | i8-terminal JSON |
| Version |
0.2.106
JSON |
| download |
| home_page | |
| Summary | Investor8 CLI |
| upload_time | 2023-09-20 14:28:59 |
| maintainer | |
| docs_url | None |
| author | investoreight |
| requires_python | |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# i8 Terminal: Modern Market Research powered by the Command-Line
[i8 terminal](https://www.i8terminal.io) is a modern python-based terminal application that gives you superior power and flexibility to understand and analyze the market. The interface is simple, efficient, and powerful: it's command-line!
i8 Terminal is backed by the [Investoreight Platform](https://www.investoreight.com) and currently covers major U.S. exchanges.
## Features and Highlights
- Prompt Market Insights and Analysis
- Custom Charting, Reporting, and Visualizations
- Powerful and Customizable Screening
- Easy-to-Use and Extendable
- Backed by the [Investoreight Platform](https://www.investoreight.com)
## i8 Terminal Commands
i8 Terminal offers some built-in commands to analyze and research the market. You can also create your own custom commands or extend the existing command. Find an overview of commands [here](https://i8terminal.io/#commands).
Check out the following video to see some more commands from i8 Terminal:
[](https://www.youtube.com/watch?v=NpOCqcb-RxY)
## Installing i8 Terminal
**Note**: i8 Terminal currently only supports Python 3.9+
If you have Python 3 installed, you can simply install the tool with Python pip:
```
pip install i8-terminal
```
We recommend installing i8 terminal in an isolated virtual environment. This can be done as follows:
#### On Mac OS or Linux:
```
python3 -m venv .venv
source .venv/bin/activate
pip install i8-terminal
```
#### On Windows:
```
python3 -m venv .venv
source .venv/Script/activate
pip install i8-terminal
```
### Install i8 Terminal using the Windows Installer
On Windows, you can also install i8 Terminal using the Windows executable. Check [here](https://i8terminal.io/download) if you want to download the windows executable.
## How to Contribute i8 Terminal
The preferred workflow for contributing to i8 Terminal is to clone the
[GitHub repository](https://github.com/investoreight/i8-terminal), develop on a branch and make a Pull Request.
See [here](https://github.com/investoreight/i8-terminal/blob/main/CONTRIBUTING.md) for guidelines for contributors.
i8 Terminal is built on top of the [Investoreight Core API](https://github.com/investoreight/investor8-sdk).
## How to Run i8 Terminal
You can verify whether i8 Terminal is installed successfully by running i8 script:
```
i8
```
If you are using the application for the first time, you should first sign in. Run the following command, which will open a browser and redirect you to the investoreight platform to sign in (or sign up):
```
i8 user login
```
After a successful login, the most convenient way to use i8 terminal is to use its own shell:
```
i8 shell
```
You should now be able to run i8 commands. Check our [documentation](https://docs.i8terminal.io/) for more details.
## Documentation
Click [here](https://docs.i8terminal.io/) to find more details about the commands.
Raw data
{
"_id": null,
"home_page": "",
"name": "i8-terminal",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "investoreight",
"author_email": "info@investoreight.com",
"download_url": "https://files.pythonhosted.org/packages/0e/91/5a2ac18f69f8e9d13a7475a8995f30946889b853b908a0adb320751a9c43/i8-terminal-0.2.106.tar.gz",
"platform": null,
"description": "# i8 Terminal: Modern Market Research powered by the Command-Line\n\n[i8 terminal](https://www.i8terminal.io) is a modern python-based terminal application that gives you superior power and flexibility to understand and analyze the market. The interface is simple, efficient, and powerful: it's command-line!\n\ni8 Terminal is backed by the [Investoreight Platform](https://www.investoreight.com) and currently covers major U.S. exchanges.\n\n## Features and Highlights\n- Prompt Market Insights and Analysis\n- Custom Charting, Reporting, and Visualizations\n- Powerful and Customizable Screening\n- Easy-to-Use and Extendable\n- Backed by the [Investoreight Platform](https://www.investoreight.com)\n\n\n\n## i8 Terminal Commands\ni8 Terminal offers some built-in commands to analyze and research the market. You can also create your own custom commands or extend the existing command. Find an overview of commands [here](https://i8terminal.io/#commands).\n\nCheck out the following video to see some more commands from i8 Terminal:\n\n[](https://www.youtube.com/watch?v=NpOCqcb-RxY)\n\n\n## Installing i8 Terminal\n**Note**: i8 Terminal currently only supports Python 3.9+\n\nIf you have Python 3 installed, you can simply install the tool with Python pip:\n\n```\npip install i8-terminal\n```\n\nWe recommend installing i8 terminal in an isolated virtual environment. This can be done as follows:\n\n#### On Mac OS or Linux:\n\n```\npython3 -m venv .venv\nsource .venv/bin/activate\npip install i8-terminal\n```\n\n#### On Windows:\n\n```\npython3 -m venv .venv\nsource .venv/Script/activate\npip install i8-terminal\n```\n\n### Install i8 Terminal using the Windows Installer\nOn Windows, you can also install i8 Terminal using the Windows executable. Check [here](https://i8terminal.io/download) if you want to download the windows executable.\n\n\n## How to Contribute i8 Terminal\nThe preferred workflow for contributing to i8 Terminal is to clone the\n[GitHub repository](https://github.com/investoreight/i8-terminal), develop on a branch and make a Pull Request.\n\nSee [here](https://github.com/investoreight/i8-terminal/blob/main/CONTRIBUTING.md) for guidelines for contributors.\n\ni8 Terminal is built on top of the [Investoreight Core API](https://github.com/investoreight/investor8-sdk).\n\n## How to Run i8 Terminal\nYou can verify whether i8 Terminal is installed successfully by running i8 script:\n\n```\ni8\n```\n\nIf you are using the application for the first time, you should first sign in. Run the following command, which will open a browser and redirect you to the investoreight platform to sign in (or sign up):\n\n```\ni8 user login\n```\n\nAfter a successful login, the most convenient way to use i8 terminal is to use its own shell:\n\n```\ni8 shell\n```\n\nYou should now be able to run i8 commands. Check our [documentation](https://docs.i8terminal.io/) for more details.\n\n## Documentation\nClick [here](https://docs.i8terminal.io/) to find more details about the commands.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Investor8 CLI",
"version": "0.2.106",
"project_urls": {
"Bug Tracker": "https://github.com/investoreight/i8-terminal/issues",
"Documentation": "https://docs.i8terminal.io/",
"Download": "https://i8terminal.io/download",
"Homepage": "https://i8terminal.io/",
"Source Code": "https://github.com/investoreight/i8-terminal"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0e915a2ac18f69f8e9d13a7475a8995f30946889b853b908a0adb320751a9c43",
"md5": "bb40034088b7f62ee03f6d55e9c62a25",
"sha256": "c93c2bea13808a2dfc1406bb24e96b93db507c77560ba9a02da169575fbd50b4"
},
"downloads": -1,
"filename": "i8-terminal-0.2.106.tar.gz",
"has_sig": false,
"md5_digest": "bb40034088b7f62ee03f6d55e9c62a25",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 188163,
"upload_time": "2023-09-20T14:28:59",
"upload_time_iso_8601": "2023-09-20T14:28:59.088445Z",
"url": "https://files.pythonhosted.org/packages/0e/91/5a2ac18f69f8e9d13a7475a8995f30946889b853b908a0adb320751a9c43/i8-terminal-0.2.106.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-20 14:28:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "investoreight",
"github_project": "i8-terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "i8-terminal"
}
