# 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
```
## 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
- [cargo]
- [poetry] 1.4+
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 (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:
```shell
# 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:
```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
Raw data
{
"_id": null,
"home_page": "https://github.com/RGB-Tools/rgb-lib-python",
"name": "rgb-lib",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9.0,<4.0.0",
"maintainer_email": "",
"keywords": "rgb,bitcoin",
"author": "Zoe Faltib\u00e0",
"author_email": "zoefaltiba@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/96/25/ca7f46a32e3e169b1b7ad49c027958c26a7740286b1f290e3d80fbb46a23/rgb_lib-0.2.0.tar.gz",
"platform": null,
"description": "# RGB Lib Python bindings\n\nThis project builds a Python library, `rgb-lib`, for the [rgb-lib]\nRust library, which is included as a git submodule. The bindings are created by\nthe [rgb-lib-ffi] project, which is located inside the rgb-lib submodule.\n\n## Install from PyPI\n\nInstall the [latest release] by running:\n```shell\npip install rgb-lib\n```\n\n## Demo\n\nThe `demo/` directory contains a demonstration of the most common operations in\nthe form of a Jupyter notebook. See the included `README.md` file for more\ndetails.\n\n## Install locally\n\n### Requirements\n- [cargo]\n- [poetry] 1.4+\n\nIn order to install the project locally, run:\n```shell\n# Update the submodule\ngit submodule update --init\n\n# Generate the bindings\n./generate.sh\n\n# Build the source and wheels archives\npoetry build\n\n# Install the wheel (replacing <version> with built version)\npip install ./dist/rgb_lib-<version>-py3-none-any.whl\n\n# or install the sdist (replacing <version> with built version)\npip install ./dist/rgb_lib-<version>.tar.gz\n```\n\n## Build in Docker\nIn order to build the project in a Docker container, run:\n```shell\n# Update the submodule\ngit submodule update --init\n\n# run the build script\n./build_in_docker.sh\n```\n\nThe `build_in_docker.sh` script will build the docker image and use it to first\ngenerate the bindings, then build the source and wheel archives. Once the build\ncompletes, archives will be available in the `dist/` directory as if they were\nbuilt locally.\n\n## Publish\n\nPublishing to PyPI is handled with Poetry.\n\nTo configure the access token, which only needs to be done once, run:\n```shell\npoetry config pypi-token.pypi <token>\n```\n\nTo publish a new release run:\n```shell\npoetry publish\n```\n\n\n[cargo]: https://github.com/rust-lang/cargo\n[rgb-lib]: https://github.com/RGB-Tools/rgb-lib\n[rgb-lib-ffi]: https://github.com/RGB-Tools/rgb-lib/tree/master/rgb-lib-ffi\n[latest release]: https://pypi.org/project/rgb-lib/\n[poetry]: https://github.com/python-poetry/poetry\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "RGB Lib Python language bindings.",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/RGB-Tools/rgb-lib-python",
"Homepage": "https://github.com/RGB-Tools/rgb-lib-python",
"Repository": "https://github.com/RGB-Tools/rgb-lib-python"
},
"split_keywords": [
"rgb",
"bitcoin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3fcd9e51f4177816c287cd5d43241b386d6cf7bd8b07977cc2325bf6f65b49e4",
"md5": "7c1eb27d78915c67ba0db6c8a7df13c2",
"sha256": "924046d74f9226d08b926ddb69802be9d36a9f6f9000119151705be1a160aa8a"
},
"downloads": -1,
"filename": "rgb_lib-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c1eb27d78915c67ba0db6c8a7df13c2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0,<4.0.0",
"size": 125661697,
"upload_time": "2023-11-07T17:48:51",
"upload_time_iso_8601": "2023-11-07T17:48:51.663580Z",
"url": "https://files.pythonhosted.org/packages/3f/cd/9e51f4177816c287cd5d43241b386d6cf7bd8b07977cc2325bf6f65b49e4/rgb_lib-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9625ca7f46a32e3e169b1b7ad49c027958c26a7740286b1f290e3d80fbb46a23",
"md5": "a4f356d923964993f7c44fef024f93f3",
"sha256": "94128d3908a8e9a5dd56254fec796e117464f5b6aad6dc186a6a25b96bd2b2ef"
},
"downloads": -1,
"filename": "rgb_lib-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a4f356d923964993f7c44fef024f93f3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0,<4.0.0",
"size": 124302306,
"upload_time": "2023-11-07T18:09:51",
"upload_time_iso_8601": "2023-11-07T18:09:51.107296Z",
"url": "https://files.pythonhosted.org/packages/96/25/ca7f46a32e3e169b1b7ad49c027958c26a7740286b1f290e3d80fbb46a23/rgb_lib-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-07 18:09:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "RGB-Tools",
"github_project": "rgb-lib-python",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rgb-lib"
}
JSON
