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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: robonomics-interface-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 e83efd507acf200ab6d0f733986a1d58bfa2b3b06bd0c24772426d84caeb52be
MD5 5d3a0215036fc4a916441d7b216c6bad
BLAKE2b-256 6a87f0da669c9afaf8aae45b112732b68718ab3a8a19f96d1a2fdd269d94956a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robonomics_interface-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b229fa70d1d1a947b42463770d95b27d0e6dec16423b9f970dcb7164b955fa24
MD5 d9157fd68fe66fec94c7ec997441cb7e
BLAKE2b-256 0d0dcc12a9dee7e4fc250ac3d0f365664c855d48b0364653c73ec265562dad0c

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