Metadata-Version: 2.1
Name: rgb-lib
Version: 0.1.2
Summary: RGB Lib Python language bindings.
Home-page: https://github.com/RGB-Tools/rgb-lib-python
License: MIT
Keywords: rgb,bitcoin
Author: Zoe Faltibà
Author-email: zoefaltiba@gmail.com
Requires-Python: >=3.9.0,<4.0.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Other/Nonlisted Topic
Project-URL: Documentation, https://github.com/RGB-Tools/rgb-lib-python
Project-URL: Repository, https://github.com/RGB-Tools/rgb-lib-python
Description-Content-Type: text/markdown

# RGB Lib Python bindings

This project builds a Python library, `rgb-lib`, for the [rgb-lib]
Rust library, which is included as a git submodule. The bindings are created by
the [rgb-lib-ffi] project, which is located inside the rgb-lib submodule.

## Install from PyPI

Install the [latest release] by running:
```shell
pip install rgb-lib
```

## Install locally

### Requirements
- [cargo]
- [poetry]

In order to install the project locally, run:
```shell
# Update the submodule
git submodule update --init

# Generate the bindings
./generate.sh

# Build the source and wheels archives
poetry build

# Install the wheel
pip install ./dist/rgb_lib-<version>-py3-none-any.whl

# or install the sdist
pip install ./dist/rgb-lib-<version>.tar.gz
```

## Publish

Publishing to PyPI is handled with Poetry.

To configure the access token, which only needs to be done once, run:
```shell
poetry config pypi-token.pypi <token>
```

To publish a new release run:
```shell
poetry publish
```


[cargo]: https://github.com/rust-lang/cargo
[rgb-lib]: https://github.com/RGB-Tools/rgb-lib
[rgb-lib-ffi]: https://github.com/RGB-Tools/rgb-lib/tree/master/rgb-lib-ffi
[latest release]: https://pypi.org/project/rgb-lib/
[poetry]: https://github.com/python-poetry/poetry

