Skip to main content

Robonomics wrapper over https://github.com/polkascan/py-substrate-interface created to facilitate programming with Robonomics

Project description

robonomics-interface

This is a simple wrapper over https://github.com/polkascan/py-substrate-interface used to facilitate writing code for applications using Robonomics.

Robonomics project: https://robonomics.network/

Robonomics parachain dapp: https://parachain.robonomics.network/

Documentation: https://multi-agent-io.github.io/robonomics-interface/


Installation

pip3 install robonomics-interface

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Pull Request Process

  1. Install poetry
  2. Git clone the repository
  3. Install requirements with
poetry install

Installing substrate_interface may require Rust and Rustup nightly.

  1. Add functions/edit code/fix issues.
  2. Make a PR.
  3. ...
  4. Profit!

Some important rules

  • If needed, install dependencies with
poetry add <lib>
  • Use ReStructuredText docstrings.
  • Respect typing annotation.
  • Add documentation. Please take in consideration that if a new class was created, add it to docs/source/modules.rst. Other functionality is better to be described in docs/source/usage.rst
  • Black it:
black -l 120 <modified_file>
  • Check how the docs look via make html from the docs folder and checking the docs/build/html/index.html page.
  • Do not bump version.
  • One may test the code by
# in project root
poetry build
pip3 uninstall robonomcis_interface -y  #if was installed previously
pip3 install pip3 install dist/robonomics_interface-<version>-py3-none-any.whl 
python3 <testing_script>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robonomics-interface-1.0.4.tar.gz (20.2 kB view details)

Uploaded Source

Built Distribution

robonomics_interface-1.0.4-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file robonomics-interface-1.0.4.tar.gz.

File metadata

  • Download URL: robonomics-interface-1.0.4.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.12 Linux/5.13.0-1023-azure

File hashes

Hashes for robonomics-interface-1.0.4.tar.gz
Algorithm Hash digest
SHA256 723ecc86be7f783dc29974041dd631eccd18697a57ab1c14695ea2bd9ea7d896
MD5 bc9caf2db78f4e3bd95704c0c49dbea4
BLAKE2b-256 7942320d6be6b7edf383e82ba8a2e7957b7aa57fbe5b5c0ee2acd8d8f6f4b91a

See more details on using hashes here.

File details

Details for the file robonomics_interface-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for robonomics_interface-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4d4b7914d4a117519751ed5087f1e13f3a981dc5c3a60d0b3785f77b0d447506
MD5 ca3b4990d07d5f3c3661269f8d851dc2
BLAKE2b-256 f763e361ec7bba2a2f3a1b702055c6d9182ecaf5d6b7aa9a0467ed01ed83b7a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page