# ipfsclient
IPFS RPC Client
- [Installation](#installation)
- [Documentation](#documentation)
* [Build docs locally](#build-docs-locally)
- [Tests](#tests)
* [Before running tests:](#before-running-tests-)
+ [Regenerate pb2.py files](#regenerate-pb2py-files)
+ [Ipfs setup](#ipfs-setup)
+ [Run the ipfs daemon](#run-the-ipfs-daemon)
- [IPFS troubleshooting](#ipfs-troubleshooting)
## Installation
```
pip install ipfsclient
```
## Documentation
https://ipfsclient.readthedocs.io/
### Build docs locally
`mkdocs serve`
## Tests
To only run tests: `pytest`
To run all checks: `nox`
### Before running tests:
#### Regenerate pb2.py files
```
cd protobuf;
protoc --python_out=../proto --proto_path=protobuf protobuf/sample.proto
```
#### Ipfs setup
https://docs.ipfs.tech/install/
#### 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 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/ipfsclient",
"name": "ipfsclient",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "",
"author": "Nathaniel Schultz",
"author_email": "nate@nanoswap.finance",
"download_url": "https://files.pythonhosted.org/packages/21/48/7f2c19af3dc95fde12276cd7a0cdaa469e214c381b174353dace1d92a94e/ipfsclient-0.1.1.tar.gz",
"platform": null,
"description": "# ipfsclient\n\nIPFS RPC Client\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 + [Regenerate pb2.py files](#regenerate-pb2py-files)\n + [Ipfs setup](#ipfs-setup)\n + [Run the ipfs daemon](#run-the-ipfs-daemon)\n- [IPFS troubleshooting](#ipfs-troubleshooting)\n\n## Installation\n\n```\npip install ipfsclient\n```\n\n## Documentation\n\nhttps://ipfsclient.readthedocs.io/\n\n### Build docs locally\n`mkdocs serve`\n\n## Tests\nTo only run tests: `pytest` \nTo run all checks: `nox`\n\n### Before running tests:\n\n#### Regenerate pb2.py files \n```\ncd protobuf;\nprotoc --python_out=../proto --proto_path=protobuf protobuf/sample.proto\n```\n\n#### Ipfs setup\nhttps://docs.ipfs.tech/install/ \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\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": "",
"summary": "IPFS RPC Client",
"version": "0.1.1",
"project_urls": {
"Bug Tracker": "https://github.com/nanoswap/ipfsclient/issues",
"Homepage": "https://github.com/nanoswap/ipfsclient"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c9c96b3ddcc74daf9f2e352993409f6daa070ac0052f2c995ea0d2aeb166483",
"md5": "14bfa0b0bc6857268b66aff502876d48",
"sha256": "f1c42ecc1400f305ac7fd69eca2eddf47eade0e871505728f9e42bb652a7982f"
},
"downloads": -1,
"filename": "ipfsclient-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "14bfa0b0bc6857268b66aff502876d48",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5749,
"upload_time": "2023-07-23T19:37:20",
"upload_time_iso_8601": "2023-07-23T19:37:20.850830Z",
"url": "https://files.pythonhosted.org/packages/5c/9c/96b3ddcc74daf9f2e352993409f6daa070ac0052f2c995ea0d2aeb166483/ipfsclient-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "21487f2c19af3dc95fde12276cd7a0cdaa469e214c381b174353dace1d92a94e",
"md5": "a7f1e3a5c5aa3ae368f53a185cba89cc",
"sha256": "d49729f2438572b8d422cfbd3b7391e9887d01ade516cd5bbbbcbb19e8f52311"
},
"downloads": -1,
"filename": "ipfsclient-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "a7f1e3a5c5aa3ae368f53a185cba89cc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 5463,
"upload_time": "2023-07-23T19:37:23",
"upload_time_iso_8601": "2023-07-23T19:37:23.622858Z",
"url": "https://files.pythonhosted.org/packages/21/48/7f2c19af3dc95fde12276cd7a0cdaa469e214c381b174353dace1d92a94e/ipfsclient-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-23 19:37:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nanoswap",
"github_project": "ipfsclient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "ipfsclient"
}
JSON
