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:
pip install rgb-lib
Demo
The demo/ directory contains a demonstration of the most common operations in
the form of a Jupyter notebook. See the included README.md file for more
details.
Install locally
Requirements
In order to install the project locally, run:
# Update the submodule
git submodule update --init
# Generate the bindings
./generate.sh
# Build the source and wheels archives
poetry build
# Install the wheel (replacing <version> with built version)
pip install ./dist/rgb_lib-<version>-py3-none-any.whl
# or install the sdist (replacing <version> with built version)
pip install ./dist/rgb_lib-<version>.tar.gz
Build in Docker
In order to build the project in a Docker container, run:
# Update the submodule
git submodule update --init
# run the build script
./build_in_docker.sh
The build_in_docker.sh script will build the docker image and use it to first
generate the bindings, then build the source and wheel archives. Once the build
completes, archives will be available in the dist/ directory as if they were
built locally.
Publish
Publishing to PyPI is handled with Poetry.
To configure the access token, which only needs to be done once, run:
poetry config pypi-token.pypi <token>
To publish a new release run:
poetry publish
Metadata
Release files for rgb-lib 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rgb_lib-0.2.0.tar.gz | 124.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rgb_lib-0.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 250.0 MB
Release files / rgb_lib-0.2.0.tar.gz
| Download URL | rgb_lib-0.2.0.tar.gz |
|---|---|
| Size | 124.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
94128d3908a8e9a5dd56254fec796e117464f5b6aad6dc186a6a25b96bd2b2ef
|
|
BLAKE2b-256 checksum How to use checksums |
9625ca7f46a32e3e169b1b7ad49c027958c26a7740286b1f290e3d80fbb46a23
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.2 Linux/6.0.0-0.deb11.6-amd64
|
Release files / rgb_lib-0.2.0-py3-none-any.whl
| Download URL | rgb_lib-0.2.0-py3-none-any.whl |
|---|---|
| Size | 125.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
924046d74f9226d08b926ddb69802be9d36a9f6f9000119151705be1a160aa8a
|
|
BLAKE2b-256 checksum How to use checksums |
3fcd9e51f4177816c287cd5d43241b386d6cf7bd8b07977cc2325bf6f65b49e4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.2 Linux/6.0.0-0.deb11.6-amd64
|