# robonomics-interface
This is a simple wrapper over 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://airalab.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/airalab/robonomics-interface",
"name": "robonomics-interface",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "python3, wrapper, blockchain, substrate, robonomics, pypi-package",
"author": "Pavel Tarasov",
"author_email": "p040399@outlook.com",
"download_url": "https://files.pythonhosted.org/packages/d7/af/9bce3764d140bb740234392312991e3d08c200e6400c55577646b09d735f/robonomics_interface-1.6.3.tar.gz",
"platform": null,
"description": "# robonomics-interface\nThis is a simple wrapper over 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://airalab.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```\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.3",
"project_urls": {
"Bug Tracker": "https://github.com/airalab/robonomics-interface/issues",
"Documentation": "https://airalab.github.io/robonomics-interface/",
"Homepage": "https://github.com/airalab/robonomics-interface",
"Repository": "https://github.com/airalab/robonomics-interface"
},
"split_keywords": [
"python3",
" wrapper",
" blockchain",
" substrate",
" robonomics",
" pypi-package"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3cddf32b77fd153669b0e35f5f06fb5f429fb3542b6740cd936a0130376c2972",
"md5": "ba9acba09329be96be93ea4a186dff5d",
"sha256": "be35241e63795cc85315ebd22f35dc4b267222590ba5c841a4099e93c11df406"
},
"downloads": -1,
"filename": "robonomics_interface-1.6.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ba9acba09329be96be93ea4a186dff5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 35024,
"upload_time": "2024-07-16T14:37:01",
"upload_time_iso_8601": "2024-07-16T14:37:01.491522Z",
"url": "https://files.pythonhosted.org/packages/3c/dd/f32b77fd153669b0e35f5f06fb5f429fb3542b6740cd936a0130376c2972/robonomics_interface-1.6.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d7af9bce3764d140bb740234392312991e3d08c200e6400c55577646b09d735f",
"md5": "b1c2615cb420203e2fd0285b66a021af",
"sha256": "48c2446d39dee5f1bf0216c251c72dcc109c4662a9678d969ab33466f50ab9c3"
},
"downloads": -1,
"filename": "robonomics_interface-1.6.3.tar.gz",
"has_sig": false,
"md5_digest": "b1c2615cb420203e2fd0285b66a021af",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 22000,
"upload_time": "2024-07-16T14:37:03",
"upload_time_iso_8601": "2024-07-16T14:37:03.446374Z",
"url": "https://files.pythonhosted.org/packages/d7/af/9bce3764d140bb740234392312991e3d08c200e6400c55577646b09d735f/robonomics_interface-1.6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 14:37:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "airalab",
"github_project": "robonomics-interface",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robonomics-interface"
}
JSON
