# 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
```bash
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](https://python-poetry.org/docs/)
2. Git clone the repository
3. Install requirements with
```bash
poetry install
```
Installing `substrate_interface` may require [Rust](https://www.rust-lang.org/tools/install) and
[Rustup nightly](https://rust-lang.github.io/rustup/concepts/channels.html).
4. Add functions/edit code/fix issues.
5. Make a PR.
6. ...
7. Profit!
## Some important rules
- If needed, install dependencies with
```bash
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:
```bash
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
```bash
# 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>
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Multi-Agent-io/robonomics-interface",
"name": "robonomics-interface",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "python3,wrapper,blockchain,substrate,robonomics,pypi-package",
"author": "Pavel Tarasov",
"author_email": "p040399@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/df/dc/552e6e85e3aa5b7954f7b7c401864c7d83581531de18926d74225bdfde59/robonomics_interface-1.6.2.tar.gz",
"platform": null,
"description": "# robonomics-interface\nThis is a simple wrapper over https://github.com/polkascan/py-substrate-interface used to facilitate writing code for applications using Robonomics.\n\nRobonomics project: https://robonomics.network/\n\nRobonomics parachain dapp: https://parachain.robonomics.network/\n\nDocumentation: https://multi-agent-io.github.io/robonomics-interface/\n_______\n# Installation \n```bash\npip3 install robonomics-interface\n```\n# Contributing\n\nWhen contributing to this repository, please first discuss the change you wish to make via issue,\nemail, or any other method with the owners of this repository before making a change. \n\n## Pull Request Process\n\n1. Install [poetry](https://python-poetry.org/docs/) \n2. Git clone the repository\n3. Install requirements with\n```bash\npoetry install\n```\nInstalling `substrate_interface` may require [Rust](https://www.rust-lang.org/tools/install) and \n[Rustup nightly](https://rust-lang.github.io/rustup/concepts/channels.html).\n\n4. Add functions/edit code/fix issues.\n5. Make a PR.\n6. ...\n7. Profit!\n\n\n## Some important rules\n- If needed, install dependencies with\n```bash\npoetry add <lib>\n```\n- Use `ReStructuredText` docstrings.\n- Respect typing annotation.\n- Add documentation. Please take in consideration that if a new class was created, add it to `docs/source/modules.rst`.\nOther functionality is better to be described in `docs/source/usage.rst`\n- Black it:\n```bash\nblack -l 120 <modified_file>\n```\n- Check how the docs look via `make html` from the `docs` folder and checking the `docs/build/html/index.html` page.\n- Do not bump version.\n- One may test the code by\n```bash\n# in project root\npoetry build\npip3 uninstall robonomcis_interface -y #if was installed previously\npip3 install pip3 install dist/robonomics_interface-<version>-py3-none-any.whl \npython3 <testing_script>\n```",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Robonomics wrapper over https://github.com/polkascan/py-substrate-interface created to facilitate programming with Robonomics",
"version": "1.6.2",
"project_urls": {
"Bug Tracker": "https://github.com/Multi-Agent-io/robonomics-interface/issues",
"Documentation": "https://multi-agent-io.github.io/robonomics-interface/",
"Homepage": "https://github.com/Multi-Agent-io/robonomics-interface",
"Repository": "https://github.com/Multi-Agent-io/robonomics-interface"
},
"split_keywords": [
"python3",
"wrapper",
"blockchain",
"substrate",
"robonomics",
"pypi-package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65182352d92a81febf2b90bad1fe2184aa00aebba61c9c835d3200e2f615abab",
"md5": "810b762f753ff96e00d1c57ffe0b0741",
"sha256": "c4c6e1aa175bd9c988e41db801c2e34b58bdf5f9a6879db1b716484f8b322166"
},
"downloads": -1,
"filename": "robonomics_interface-1.6.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "810b762f753ff96e00d1c57ffe0b0741",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 35046,
"upload_time": "2024-02-01T14:31:48",
"upload_time_iso_8601": "2024-02-01T14:31:48.822057Z",
"url": "https://files.pythonhosted.org/packages/65/18/2352d92a81febf2b90bad1fe2184aa00aebba61c9c835d3200e2f615abab/robonomics_interface-1.6.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dfdc552e6e85e3aa5b7954f7b7c401864c7d83581531de18926d74225bdfde59",
"md5": "e2a7ab4e0da5bbbfe549262f36a8beb9",
"sha256": "0d224c3b3daa6197ad0eaa7446472ef411e8850d66bd96b759b18105a940ea79"
},
"downloads": -1,
"filename": "robonomics_interface-1.6.2.tar.gz",
"has_sig": false,
"md5_digest": "e2a7ab4e0da5bbbfe549262f36a8beb9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 22019,
"upload_time": "2024-02-01T14:31:52",
"upload_time_iso_8601": "2024-02-01T14:31:52.671290Z",
"url": "https://files.pythonhosted.org/packages/df/dc/552e6e85e3aa5b7954f7b7c401864c7d83581531de18926d74225bdfde59/robonomics_interface-1.6.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-01 14:31:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Multi-Agent-io",
"github_project": "robonomics-interface",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robonomics-interface"
}
JSON
