| Name | ipfs-kvs JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | https://github.com/nanoswap/ipfs-kvs |
| Summary | IPFS python client |
| upload_time | 2023-04-17 01:31:45 |
| maintainer | |
| 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.
|
# ipfs (interplanetary filesystem) kvs (key value store)
Documentation: https://ipfs-kvs.readthedocs.io/
## Build docs
`mkdocs serve`
## Run tests
To only run tests: `pytest`
To run all checks: `nox`
Note: before running tests:
- Generate the pb2.py files used for testing
- Make sure your local ipfs daemon is running
## Regenerate pb2.py files
```
cd protobuf;
protoc --python_out=../proto --proto_path=protobuf protobuf/sample.proto
```
## Run the ipfs daemon
```
ipfs daemon --api /ip4/0.0.0.0/tcp/5001
```
Check the status of your node at:
- http://localhost:5001/webui
- https://webui.ipfs.io/#/status
### ipfs setup
https://docs.ipfs.tech/install/
### ipfs troubleshooting
Set the log level, send the logs to a file, and search the file for relevant messages
```
export IPFS_LOGGING=<debug|info|error>
ipfs daemon --debug 2>&1 | tee ipfs.log
cat ipfs.log | grep test_directory
```
If you find something important, you can show the first few lines around that message
```
grep -C 10 '2023-04-13T17:31:49.712-0400' ipfs.log
```
Here is an example of an error message in these logs:
```
2023-04-13T17:31:49.712-0400 DEBUG cmds/http http/handler.go:90 incoming API request: /files/mkdir?arg=test_directory
2023-04-13T17:31:49.712-0400 DEBUG cmds go-ipfs-cmds@v0.8.2/command.go:161 error occured in call, closing with error: paths must start with a leading slash
```
Raw data
{
"_id": null,
"home_page": "https://github.com/nanoswap/ipfs-kvs",
"name": "ipfs-kvs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "Nathaniel Schultz",
"author_email": "Nathaniel Schultz <nate@nanoswap.finance>",
"download_url": "https://files.pythonhosted.org/packages/39/aa/966accf7521ca39bbb6fd4d99acbeaf998b8d62f7a6c1346b3b31f8d7286/ipfs-kvs-0.0.2.tar.gz",
"platform": null,
"description": "# ipfs (interplanetary filesystem) kvs (key value store)\n\nDocumentation: https://ipfs-kvs.readthedocs.io/\n\n## Build docs\n`mkdocs serve`\n\n## Run tests\nTo only run tests: `pytest` \nTo run all checks: `nox`\n\nNote: before running tests:\n - Generate the pb2.py files used for testing\n - Make sure your local ipfs daemon is running\n\n## Regenerate pb2.py files\n```\ncd protobuf;\nprotoc --python_out=../proto --proto_path=protobuf protobuf/sample.proto\n```\n\n## Run the ipfs daemon\n```\nipfs daemon --api /ip4/0.0.0.0/tcp/5001\n```\nCheck the status of your node at:\n - http://localhost:5001/webui\n - https://webui.ipfs.io/#/status\n\n### ipfs setup\nhttps://docs.ipfs.tech/install/\n\n### ipfs troubleshooting\n\nSet the log level, send the logs to a file, and search the file for relevant messages\n```\nexport IPFS_LOGGING=<debug|info|error>\nipfs daemon --debug 2>&1 | tee ipfs.log\ncat ipfs.log | grep test_directory\n```\n\nIf you find something important, you can show the first few lines around that message\n```\ngrep -C 10 '2023-04-13T17:31:49.712-0400' ipfs.log\n```\n\nHere is an example of an error message in these logs:\n```\n2023-04-13T17:31:49.712-0400\tDEBUG\tcmds/http\thttp/handler.go:90\tincoming API request: /files/mkdir?arg=test_directory\n2023-04-13T17:31:49.712-0400\tDEBUG\tcmds\tgo-ipfs-cmds@v0.8.2/command.go:161\terror occured in call, closing with error: paths must start with a leading slash\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": "IPFS python client",
"version": "0.0.2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fbbf83a07ebe85cff82afdcc558cee011a892c753268146a691c31a7b6af1972",
"md5": "96204d6d40436c536a7921afaec50911",
"sha256": "a491ed365507ca955a003d37bcb66351715337fd05159f13542f44861701b287"
},
"downloads": -1,
"filename": "ipfs_kvs-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "96204d6d40436c536a7921afaec50911",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 3593,
"upload_time": "2023-04-17T01:31:42",
"upload_time_iso_8601": "2023-04-17T01:31:42.990526Z",
"url": "https://files.pythonhosted.org/packages/fb/bf/83a07ebe85cff82afdcc558cee011a892c753268146a691c31a7b6af1972/ipfs_kvs-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "39aa966accf7521ca39bbb6fd4d99acbeaf998b8d62f7a6c1346b3b31f8d7286",
"md5": "273b709d3feebbd6dae735bafaabcc63",
"sha256": "81996e3ce3ba720a68342cb21cfee9f80caba28f4bd9a3dad9689dd0134524aa"
},
"downloads": -1,
"filename": "ipfs-kvs-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "273b709d3feebbd6dae735bafaabcc63",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 3410,
"upload_time": "2023-04-17T01:31:45",
"upload_time_iso_8601": "2023-04-17T01:31:45.315477Z",
"url": "https://files.pythonhosted.org/packages/39/aa/966accf7521ca39bbb6fd4d99acbeaf998b8d62f7a6c1346b3b31f8d7286/ipfs-kvs-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 01:31:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "nanoswap",
"github_project": "ipfs-kvs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "ipfs-kvs"
}
