bits

August 7, 2025 · View on GitHub

bits is a cli tool and pure Python library for Bitcoin

Installation

pip install bits

Install for development

git clone https://github.com/jtraub91/bits.git
cd bits/
pip install -e .[dev]
pre-commit install

Usage

See the following for command line usage

bits -h

Configuration

A configuration file is not strictly necessary, but may be leveraged, nominally located at ~/.bits/config.[toml|json], for overriding CLI defaults.

See conf/ for default configuration files.

TOML is preferred for configuration files but is natively supported only on Python 3.11 and up; on the contrary, JSON is supported for all Python versions. Therefore, for all Python versions, if ~/.bits/config.json is present, it will be used, but for Python 3.11+, if ~/.bits/config.toml is present, it will be used instead.

Donate

1GjPvTLYLNodnBJ969DWHcqBMP3pa5tsV3

License

MIT License

See LICENSE.txt for details.

Docs

Documentation was scaffolded with several sphinx commands, e.g.

sphinx-quickstart docs --ext-autodoc --extensions sphinx.ext.napoleon --no-makefile --no-batchfile --sep

sphinx-apidoc src/bits -o docs/source/

To re-build the docs,

make docs

And serve the docs locally,

make docs-serve