Metadata-Version: 2.1
Name: shellmarkets
Version: 0.0.3
Summary: A CLI tool for retrieving stock market information.
Home-page: https://github.com/croketillo/SHELLMARKETS
Author: Croketillo
Author-email: croketillo@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Office/Business :: Financial :: Investment
Classifier: Topic :: Utilities
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: yfinance
Requires-Dist: colorama


<p align="center"><img src="images/SHMKT.png" width="250"></p>


![Pepy Total Downlods](https://img.shields.io/pepy/dt/shellmarkets)


# ShellMarkets

ShellMarkets is a command-line tool (CLI) for retrieving stock market information. It uses yfinance module to fetch data about specific stocks and provides various options to display detailed information about companies.

<p align="center"><img src="images/Screenshot_1.png" width="600"></p>

## Installation

You can install ShellMarkets directly from PyPI using `pip`:

```bash 
pip install shellmarkets
```



## Usage
After installation, you can use the shmkt command to interact with the tool. Below are the available options and usage examples.

<p align="center"><img src="images/Screenshot_2.png" width="600"></p>

### Show Version
To display the version of ShellMarkets:

```bash 
shmkt --version
```

### Get Basic Information
To get basic information about one or more stocks:

```bash
shmkt TICKER1 TICKER2 ...
```

### Extended Information
To get extended information about a specific stock:

```bash
shmkt TICKER -e
```

### Company Information
To get detailed information about the company:

```bash
shmkt TICKER -i
```

### Company News
To get recent news about the company:

```bash
shmkt TICKER --n
```

### Show Portfolio
To display the stocks in a portfolio file:

```bash
shmkt -p /path/to/portfolio/file
```

### Create a New Portfolio
To create a new portfolio file with an optional list of stocks:

```bash
shmkt -c /path/to/new/portfolio/file TICKER1 TICKER2 ...
```

### Add a Stock to the Portfolio
To add a stock to an existing portfolio file:

```bash
shmkt -a TICKER /path/to/portfolio/file
```

### Remove a Stock from the Portfolio
To remove a stock from an existing portfolio file:

```bash
shmkt -d TICKER /path/to/portfolio/file
``` 

### Help

```bash
shmkt --help
```

## Contributions
Contributions are welcome. Please open an issue or submit a pull request on GitHub.

## License
This project is licensed under the GNU General Public License (GPL). See the LICENSE file for details.
