Metadata-Version: 2.4
Name: CryptoTradeBot
Version: 0.1.0
Summary: CLI-first Kraken spot trading bot with hybrid rule-based and ML-driven decision support.
Project-URL: Repository, https://github.com/rainzhang05/CryptoTradeBot
Author: Rain Zhang
License: MIT License
        
        Copyright (c) 2026 Rain Zhang
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Requires-Python: <3.15,>=3.12
Requires-Dist: httpx<0.29,>=0.28
Requires-Dist: pydantic<3.0,>=2.11
Requires-Dist: python-dotenv<2.0,>=1.1
Requires-Dist: python-json-logger<4.0,>=2.0.7
Requires-Dist: pyyaml<7.0,>=6.0.2
Requires-Dist: scikit-learn<2.0,>=1.7
Requires-Dist: textual<1.0,>=0.76
Requires-Dist: typer<1.0,>=0.16
Provides-Extra: dev
Requires-Dist: build<2.0,>=1.2; extra == 'dev'
Requires-Dist: hatchling<2.0,>=1.27; extra == 'dev'
Requires-Dist: mypy<2.0,>=1.16; extra == 'dev'
Requires-Dist: pytest-cov<7.0,>=6.2; extra == 'dev'
Requires-Dist: pytest<9.0,>=8.4; extra == 'dev'
Requires-Dist: ruff<0.13,>=0.12; extra == 'dev'
Requires-Dist: types-pyyaml<7.0,>=6.0.12; extra == 'dev'
Description-Content-Type: text/markdown

# Crypto Trade Bot

CLI-first Kraken spot trading bot with an interactive operator shell for research, simulation, and live operations.

<p align="center">
  <img src="docs/assets/tradebot-shell-sample.png" alt="Crypto Trade Bot shell sample" width="620">
</p>

Crypto Trade Bot packages the repository’s documented Kraken-only workflow into a single `tradebot` command. On interactive terminals it opens the operator shell by default, while the full direct command surface remains available for automation, data preparation, backtesting, simulation, and live runtime tasks.

## Quickstart

Install `pipx` and the package:

```bash
python3 -m pip install --user pipx
pipx ensurepath
pipx install CryptoTradeBot
```

Open the shell from anywhere in your terminal with:

```bash
tradebot
```

`tradebot` launches the interactive operator shell after the package is installed.

On first launch, `tradebot` creates the default application home under `~/.tradebot/`.

## Docs

- [Crypto Trade Bot Documentation](docs/)
- [Commands](docs/shell-commands.md)

This repository is licensed under the [MIT License](LICENSE).
