bt-auto-dumper

Bittensor auto dumper, a part of Auto-validator initiative.

    

Installation

pip install bt-auto-dumper

Usage

bt-auto-dumper --help

This project uses ApiVer:

• when using bt-auto-dumper as a command line tool, in context of script, make sure you explicitly set BT_AUTO_DUMPER_APIVER=v1 env variable to ensure compatibility with future versions
• when python package itself make sure to import bt_auto_dumper.v1

Versioning

This package uses Semantic Versioning. TL;DR you are safe to use compatible release version specifier ~=MAJOR.MINOR in your pyproject.toml or requirements.txt.

Additionally, this package uses ApiVer to further reduce the risk of breaking changes. This means, the public API of this package is explicitly versioned, e.g. bt_auto_dumper.v1, and will not change in a backwards-incompatible way even when bt_auto_dumper.v2 is released.

Internal packages, i.e. prefixed by bt_auto_dumper._ do not share these guarantees and may change in a backwards-incompatible way at any time even in patch releases.

Development

Pre-requisites:

• pdm
• nox
• docker and docker compose plugin

Ideally, you should run nox -t format lint before every commit to ensure that the code is properly formatted and linted. Before submitting a PR, make sure that tests pass as well, you can do so using:

nox -t check # equivalent to `nox -t format lint test`

If you wish to install dependencies into .venv so your IDE can pick them up, you can do so using:

pdm install --dev

Release process

Run nox -s make_release -- X.Y.Z where X.Y.Z is the version you're releasing and follow the printed instructions.