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.2.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

robonomics_interface-1.0.2-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robonomics-interface-1.0.2.tar.gz
  • Upload date:
  • Size: 20.1 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.2.tar.gz
Algorithm Hash digest
SHA256 3759d1d213e6da78a5fba035fd4b70c963a95a8722860165b9eaee9eca835d1b
MD5 6704a87a899ad16a388bc90dea7aae94
BLAKE2b-256 214fc53b0b63e7293b0a3652731e5e6b3e5f49627402d1b9bddc12410ba0d760

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robonomics_interface-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 919e0e0709874d4a7d4565e61637cd089fd86551a4af46bdcb8cea951b9b821a
MD5 2fbc861f18f4f2f7b3ae20f7498a8cee
BLAKE2b-256 0161cad6be9531b3f96759894d305158ed13ea5a6895e96ef1802a42abe35a7b

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