Metadata-Version: 2.4
Name: pybinbot
Version: 0.2.10
Summary: Utility functions for the binbot project.
Author-email: Carlos Wu <carkodw@gmail.com>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic[email]>=2.0.0
Requires-Dist: numpy==2.2.0
Requires-Dist: pandas>=2.2.3
Requires-Dist: pymongo==4.6.3
Requires-Dist: pandas-stubs>=2.3.3.251219
Provides-Extra: dev
Requires-Dist: pytest>=9.0.2; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy>=1.19.1; extra == "dev"
Dynamic: license-file

# PyBinbot

Utility functions for the binbot project. Most of the code here is not runnable, there's no server or individual scripts, you simply move code to here when it's used in both binbot and binquant.

``pybinbot`` is the public API module for the distribution.

This module re-exports the internal ``shared`` and ``models`` packages and the most commonly used helpers and enums so consumers can simply::

        from pybinbot import round_numbers, ExchangeId

The implementation deliberately avoids importing heavy third-party libraries at module import time.


## Installation

```bash
uv sync --extra dev
```

`--extra dev` also installs development tools like ruff and mypy


## Publishing

1. Save your changes and do the usual Git flow (add, commit, don't push the changes yet).
2. Bump the version, choose one of these:

```bash
make bump-patch
```
or 

```bash
make bump-minor
```

or

```bash
make bump-major
```

3. Git tag the version for Github. This will read the bump version.
```
make tag
```

4. Git push


For further commands take a look at the `Makefile` such as testing `make test`
