| Name | basicnanoclient JSON |
| Version |
0.5.0
JSON |
| download |
| home_page | https://github.com/nanoswap/basicnanoclient |
| Summary | Nano RPC python client |
| upload_time | 2024-08-05 00:11:29 |
| maintainer | None |
| docs_url | None |
| author | Nathaniel Schultz |
| requires_python | >=3.11 |
| license | This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to <https://unlicense.org> |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# basicnanoclient
A nano (XNO) cryptocurrency RPC python client and client side wallet
- [Installation](#installation)
- [Documentation](#documentation)
* [Build docs locally](#build-docs-locally)
- [Tests](#tests)
* [Before running tests:](#before-running-tests-)
## Installation
```
pip install basicnanoclient
```
# Usage
https://github.com/nanoswap/basicnanoclient/blob/main/notebooks/nano.ipynb
## Documentation
https://basicnanoclient.readthedocs.io/
### Build docs locally
`mkdocs serve`
## Tests
To only run tests: `pytest --cov=basicnanoclient --cov-fail-under=80`
To run style checks:
```
flake8 basicnanoclient --docstring-convention google --ignore=D100
flake8 tests --docstring-convention google --ignore=D100
```
To run all checks: `nox`
### Before running tests:
- install a local nano test node
- run it locally
## Running a local Nano Node
```
# https://github.com/nanocurrency/nano-node/releases/
docker pull nanocurrency/nano-test:${NANO_TAG}
docker run --restart=unless-stopped -d -p 127.0.0.1:17076:17076 -v ${NANO_HOST_DIR}:/root --name ${NANO_NAME} nanocurrency/nano-test:${NANO_TAG}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/nanoswap/basicnanoclient",
"name": "basicnanoclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "Nathaniel Schultz",
"author_email": "Nathaniel Schultz <nate@nanoswap.finance>",
"download_url": null,
"platform": null,
"description": "# basicnanoclient\n\nA nano (XNO) cryptocurrency RPC python client and client side wallet\n\n\n\n\n\n\n- [Installation](#installation)\n- [Documentation](#documentation)\n * [Build docs locally](#build-docs-locally)\n- [Tests](#tests)\n * [Before running tests:](#before-running-tests-)\n\n## Installation\n\n```\npip install basicnanoclient\n```\n\n# Usage\n\nhttps://github.com/nanoswap/basicnanoclient/blob/main/notebooks/nano.ipynb\n\n## Documentation\n\nhttps://basicnanoclient.readthedocs.io/\n\n### Build docs locally\n`mkdocs serve`\n\n## Tests\nTo only run tests: `pytest --cov=basicnanoclient --cov-fail-under=80`\n\nTo run style checks: \n```\nflake8 basicnanoclient --docstring-convention google --ignore=D100\nflake8 tests --docstring-convention google --ignore=D100\n```\n\nTo run all checks: `nox`\n\n### Before running tests:\n\n- install a local nano test node\n- run it locally\n\n## Running a local Nano Node\n\n```\n# https://github.com/nanocurrency/nano-node/releases/\ndocker pull nanocurrency/nano-test:${NANO_TAG}\ndocker run --restart=unless-stopped -d -p 127.0.0.1:17076:17076 -v ${NANO_HOST_DIR}:/root --name ${NANO_NAME} nanocurrency/nano-test:${NANO_TAG}\n```\n",
"bugtrack_url": null,
"license": "This is free and unencumbered software released into the public domain. Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, please refer to <https://unlicense.org> ",
"summary": "Nano RPC python client",
"version": "0.5.0",
"project_urls": {
"Bug Tracker": "https://github.com/nanoswap/basicnanoclient/issues",
"Homepage": "https://github.com/nanoswap/basicnanoclient"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "15c5eea297bb79434277f90cc4874a2f7f0ecd98517ee2ac5e7701d96303a2b1",
"md5": "a0e78763c67c8cd7a5f646a36f9c646b",
"sha256": "4c87c96e3ac4676020713efc087d631a7e213c6c6f8f81d6026f4cb7398a0e46"
},
"downloads": -1,
"filename": "basicnanoclient-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0e78763c67c8cd7a5f646a36f9c646b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9774,
"upload_time": "2024-08-05T00:11:29",
"upload_time_iso_8601": "2024-08-05T00:11:29.828902Z",
"url": "https://files.pythonhosted.org/packages/15/c5/eea297bb79434277f90cc4874a2f7f0ecd98517ee2ac5e7701d96303a2b1/basicnanoclient-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 00:11:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nanoswap",
"github_project": "basicnanoclient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "basicnanoclient"
}
