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

Uploaded Source

Built Distribution

robonomics_interface-1.1.0-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robonomics-interface-1.1.0.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.9.13 Linux/5.15.0-1014-azure

File hashes

Hashes for robonomics-interface-1.1.0.tar.gz
Algorithm Hash digest
SHA256 33eadc1052a8b12a0fda6b21156c038676c8049c3d5ad6cf02f5a8ace3b0a493
MD5 5579bb1cb694642d185660cee24a1b8d
BLAKE2b-256 2b74149857b5963ac78278002bd08fc38b71a423415a1b59cb57c802e403452d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for robonomics_interface-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f2c59e6d52c3e89b8e9cf896aaa558e8e90a403d11371f5ab4a1d80fd5cfed04
MD5 4d5c1ae457e309109d60a711ef6da89b
BLAKE2b-256 b709e19bb79512e5d0302f379edb070d98e798195f01e50596ae75379ee51fef

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