This is a simple wrapper over polkascan/py-substrate-interface used to facilitate writing code for applications using Robonomics Polkadot Parachain.
Warning
Starting from 2.0 the default websocket is changed to wss://polkadot.rpc.robonomics.network/.
Use wss://kusama.rpc.robonomics.network/ for Kusama Parachain.
Robonomics project: https://robonomics.network/
Robonomics parachain dapp: https://polkadot.js.org/apps/?rpc=wss%3A%2F%2Fpolkadot.rpc.robonomics.network%2F#/explorer
Documentation: https://airalab.github.io/robonomics-interface/
pip3 install robonomics-interfaceWhen 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.
- Install poetry
- Git clone the repository
- Install requirements with
poetry installInstalling substrate_interface may require Rust and
Rustup nightly.
- Add functions/edit code/fix issues.
- Make a PR.
- ...
- Profit!
- If needed, install dependencies with
poetry add <lib>- Use
ReStructuredTextdocstrings. - 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 indocs/source/usage.rst - Black it:
black -l 120 <modified_file>- Check how the docs look via
make htmlfrom thedocsfolder and checking thedocs/build/html/index.htmlpage. - 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>