Metadata-Version: 2.1
Name: pyqqq-cli
Version: 0.4.6
Summary: CLI tool for controlling strategies deployed on the PyQQQ platform.
License: MIT
Author: PyQQQ team
Author-email: pyqqq.cs@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: click (>=8.1.7,<9.0.0)
Requires-Dist: freezegun (>=1.5.1,<2.0.0)
Requires-Dist: openai (>=1.35.10,<2.0.0)
Requires-Dist: pylint (>=3.2.5,<4.0.0)
Requires-Dist: pyqqq (>=0.12,<0.13)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: websockets (>=12.0,<13.0)
Project-URL: Documentation, https://qupiato-sdk-18secs-cf54ebea1b14b422537daf0462fb86d68f4582d064a4.gitlab.io
Description-Content-Type: text/markdown

## pyqqq-cli

### Installation

You can install `pyqqq-cli` via pip:

```bash
pip install pyqqq-cli
```

### Usage

After installation, the `qqq` command will be available. You can execute it with various subcommands:

```bash
qqq [OPTIONS] COMMAND [ARGS]...
```

#### Options

- `--help`: Show the help message and exit.

#### Commands

- `backtest`: Deploy a backtest
- `delete`: Delete a deployed strategy
- `deploy`: Deploy a strategy
- `lint`: Ensure that pylint is installed in the current python...
- `list`: List deployed strategies
- `logs`: Show logs of a deployed strategy
- `pause`: Pause a deployed strategy
- `pull`: Download an strategy from the registry
- `resume`: Resume a paused strategy
- `run`: Run a strategy
- `search`: Search for stock investment strategies
- `update`: Update the environment of the deployed strategy
- `version`: Show version number and quit

### Example

```bash
qqq deploy my_strategy_name
```

This command deploys a strategy named `my_strategy_name`.

```bash
qqq list
```

This command lists all deployed strategies.

```bash
qqq logs my_strategy_name
```

This command shows logs of the deployed strategy named `my_strategy_name`.

### License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.



