Metadata-Version: 2.1
Name: pycwatch-cli
Version: 2.1.0
Summary: A CLI application for the Cryptowatch Rest API.
Home-page: https://github.com/ljnsn/pycwatch
License: MIT
Keywords: cryptocurrency,crypto,prices,cryptowatch
Author: ljnsn
Author-email: 82611987+ljnsn@users.noreply.github.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Provides-Extra: test
Requires-Dist: black (>=22.1,<24.0) ; extra == "test"
Requires-Dist: coverage[toml] (>=6.3.2,<8.0.0) ; extra == "test"
Requires-Dist: mypy (>=0.931) ; extra == "test"
Requires-Dist: pre-commit (<4.0) ; extra == "test"
Requires-Dist: pycwatch-lib (==2.1.0)
Requires-Dist: pytest (>=7.0.1) ; extra == "test"
Requires-Dist: pytest-cov (>=3,<5) ; extra == "test"
Requires-Dist: rich (>=13.5.2,<14.0.0)
Requires-Dist: ruff (>=0.0.253) ; extra == "test"
Requires-Dist: typer (>=0.9.0,<0.10.0)
Project-URL: Repository, https://github.com/ljnsn/pycwatch
Description-Content-Type: text/markdown

# pycwatch-cli

[![Coverage](https://img.shields.io/codecov/c/github/ljnsn/pycwatch?color=%2334D058)](https://codecov.io/gh/ljnsn/pycwatch)
[![Package version](https://img.shields.io/pypi/v/pycwatch?color=%2334D058&label=pypi%20package)](https://pypi.org/project/pycwatch)
[![Python versions](https://img.shields.io/pypi/pyversions/pycwatch.svg)](https://pypi.org/project/pycwatch)
[![Black style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

The `pycwatch-cli` is a command line application that makes the power of CryptoWatch
available to you on the command line.

### CLI Installation

The easiest way to install is with [`pipx`](https://pypa.github.io/pipx/).

```bash
pipx install pycwatch-cli
```

This will make the command `pycw` available.

### CLI Quick Start

Run `pycw --help` to get usage info.

```
❯ pycw --help
                                                                                                            
 Usage: pycw [OPTIONS] COMMAND [ARGS]...                                                                    
                                                                                                            
 PyCwatch CLI.                                                                                              
                                                                                                           
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ assets                           Get or list assets.                     │
│ exchanges                        Get or list exchanges.                  │
│ info                             Get API info.                           │
│ markets                          Get or list markets.                    │
│ pairs                            Get or list pairs.                      │
╰──────────────────────────────────────────────────────────────────────────╯
```

All the endpoints implemented by `pycwatch-lib` are available via the `pycw` command.
For example:

```bash
# list available assets
pycw assets list
# get some price info
pycw markets price binance btceur
```

