shellmarkets

Name	shellmarkets JSON
Version	0.0.2 JSON
	download
home_page	https://github.com/croketillo/SHELLMARKETS
Summary	A CLI tool for retrieving stock market information.
upload_time	2024-05-26 12:04:40
maintainer	None
docs_url	None
author	Croketillo
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

![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.

## 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.

### 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.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/croketillo/SHELLMARKETS",
    "name": "shellmarkets",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Croketillo",
    "author_email": "croketillo@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/c1/94/60024c9919ec4512481f13d0b8ce2f35cc13ce4de23fed24ae736b768743/shellmarkets-0.0.2.tar.gz",
    "platform": null,
    "description": "\n<p align=\"center\"><img src=\"images/SHMKT.png\" width=\"250\"></p>\n\n\n![Pepy Total Downlods](https://img.shields.io/pepy/dt/shellmarkets)\n\n\n# ShellMarkets\n\nShellMarkets 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.\n\n## Installation\n\nYou can install ShellMarkets directly from PyPI using `pip`:\n\n```bash \npip install shellmarkets\n```\n\n\n\n## Usage\nAfter installation, you can use the shmkt command to interact with the tool. Below are the available options and usage examples.\n\n\n### Show Version\nTo display the version of ShellMarkets:\n\n```bash \nshmkt --version\n```\n\n### Get Basic Information\nTo get basic information about one or more stocks:\n\n```bash\nshmkt TICKER1 TICKER2 ...\n```\n\n### Extended Information\nTo get extended information about a specific stock:\n\n```bash\nshmkt TICKER -e\n```\n\n### Company Information\nTo get detailed information about the company:\n\n```bash\nshmkt TICKER -i\n```\n\n### Company News\nTo get recent news about the company:\n\n```bash\nshmkt TICKER --n\n```\n\n### Show Portfolio\nTo display the stocks in a portfolio file:\n\n```bash\nshmkt -p /path/to/portfolio/file\n```\n\n### Create a New Portfolio\nTo create a new portfolio file with an optional list of stocks:\n\n```bash\nshmkt -c /path/to/new/portfolio/file TICKER1 TICKER2 ...\n```\n\n### Add a Stock to the Portfolio\nTo add a stock to an existing portfolio file:\n\n```bash\nshmkt -a TICKER /path/to/portfolio/file\n```\n\n### Remove a Stock from the Portfolio\nTo remove a stock from an existing portfolio file:\n\n```bash\nshmkt -d TICKER /path/to/portfolio/file\n``` \n\n### Help\n\n```bash\nshmkt --help\n```\n\n## Contributions\nContributions are welcome. Please open an issue or submit a pull request on GitHub.\n\n## License\nThis project is licensed under the GNU General Public License (GPL). See the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A CLI tool for retrieving stock market information.",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/croketillo/SHELLMARKETS"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "69939e1ea3fbf62a1e167b7fa6872fc7cb2fa33558644250137fb169a1ed8d0a",
                "md5": "627e8d092ec1a2b4934a7ca29aaa9508",
                "sha256": "f147fc7af88f16fcc6e2567e31458ed3cecc8883c29eed284e4c1239e5a7175c"
            },
            "downloads": -1,
            "filename": "shellmarkets-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "627e8d092ec1a2b4934a7ca29aaa9508",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 5026,
            "upload_time": "2024-05-26T12:04:36",
            "upload_time_iso_8601": "2024-05-26T12:04:36.840977Z",
            "url": "https://files.pythonhosted.org/packages/69/93/9e1ea3fbf62a1e167b7fa6872fc7cb2fa33558644250137fb169a1ed8d0a/shellmarkets-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c19460024c9919ec4512481f13d0b8ce2f35cc13ce4de23fed24ae736b768743",
                "md5": "9c8fe9970eb8c1600685adc46c9bbe8c",
                "sha256": "56c4d238fcc5d0b00adf9b2ecc873bc2f0a7e98f7781f912612c2532086b3adb"
            },
            "downloads": -1,
            "filename": "shellmarkets-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "9c8fe9970eb8c1600685adc46c9bbe8c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4979,
            "upload_time": "2024-05-26T12:04:40",
            "upload_time_iso_8601": "2024-05-26T12:04:40.743044Z",
            "url": "https://files.pythonhosted.org/packages/c1/94/60024c9919ec4512481f13d0b8ce2f35cc13ce4de23fed24ae736b768743/shellmarkets-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-26 12:04:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "croketillo",
    "github_project": "SHELLMARKETS",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "shellmarkets"
}

Croketillo