rgb-lib-python is here

Author: zoedberg

.gitignore

@@ -0,0 +1,5 @@
+**/__pycache__
+/dist/
+/poetry.lock
+/rgb_lib/_rgb_lib/librgblibffi.so
+/rgb_lib/_rgb_lib/rgb_lib.py

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "rgb-lib"]
+	path = rgb-lib
+	url = https://github.com/RGB-Tools/rgb-lib.git

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 RGB-Tools developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,43 @@
+# 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
+```
+
+
+[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

generate.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+SCRIPT_DIR="$(dirname "$(realpath "$0")")"
+PY_SRC="${SCRIPT_DIR}/rgb_lib/_rgb_lib/"
+
+RGBLIBFFI_PATH="./rgb-lib/rgb-lib-ffi"
+MANIFEST_PATH=(--manifest-path "$RGBLIBFFI_PATH/Cargo.toml")
+
+echo "Generating librgblibffi.so..."
+cargo build "${MANIFEST_PATH[@]}"
+cp "$RGBLIBFFI_PATH/target/debug/librgblibffi.so" "$PY_SRC/"
+
+echo "Generating rgb_lib.py..."
+RGBFFI_BINDGEN_OUTPUT_DIR="$PY_SRC" cargo run "${MANIFEST_PATH[@]}" \
+    --package rgb-lib-ffi-bindgen -- \
+    --language python --udl-file $RGBLIBFFI_PATH/src/rgb-lib.udl

pyproject.toml

@@ -0,0 +1,29 @@
+[tool.poetry]
+name = 'rgb-lib'
+version = '0.0.1'
+description = 'RGB Lib Python language bindings.'
+license = 'MIT'
+authors = ['Zoe Faltibà <zoefaltiba@gmail.com>', 'Nicola Busanello <nicola.busanello@gmail.com>']
+readme = 'README.md'
+homepage = 'https://github.com/RGB-Tools/rgb-lib-python'
+repository = 'https://github.com/RGB-Tools/rgb-lib-python'
+documentation = 'https://github.com/RGB-Tools/rgb-lib-python'
+keywords = ['rgb', 'bitcoin']
+classifiers = [
+    'Development Status :: 4 - Beta',
+    'Intended Audience :: Developers',
+    'Natural Language :: English',
+    'Operating System :: MacOS',
+    'Operating System :: POSIX :: Linux',
+    'Programming Language :: Python :: 3.9',
+    'Programming Language :: Python :: 3.10',
+    'Topic :: Other/Nonlisted Topic',
+]
+include = ["rgb_lib/_rgb_lib/*"]
+
+[tool.poetry.dependencies]
+python = "^3.9.0"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"

rgb-lib

@@ -0,0 +1,3 @@
+"""RGB Lib package."""
+
+from ._rgb_lib.rgb_lib import *

rgb_lib/__init__.py

@@ -0,0 +1 @@
+"""Private package containing generated files."""