Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanoswap/bizlogic
Business logic wrapper of IPFS CRUD
https://github.com/nanoswap/bizlogic
business-logic ipfs nanocurrency nox pypi-package python readthedocs
Last synced: 18 days ago
JSON representation
Business logic wrapper of IPFS CRUD
- Host: GitHub
- URL: https://github.com/nanoswap/bizlogic
- Owner: nanoswap
- License: unlicense
- Created: 2023-04-18T15:21:02.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T21:32:53.000Z (over 1 year ago)
- Last Synced: 2024-11-17T00:27:20.051Z (3 months ago)
- Topics: business-logic, ipfs, nanocurrency, nox, pypi-package, python, readthedocs
- Language: Python
- Homepage:
- Size: 92.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BizLogic
Some nanoswap business logic
- [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 bizlogic
```
## Documentation
https://bizlogic.readthedocs.io/
### Build docs locally
`mkdocs serve`
## Tests
To only run tests: `pytest --cov=bizlogic --log-cli-level=debug`
To only run lints: `flake8 bizlogic --docstring-convention google --ignore=D100,D104 --exclude=loan_pb2.py,vouch_pb2.py,loan_application_pb2.py`
To run all checks: `nox`
### Before running tests:
#### Regenerate pb2.py files
```
protoc --python_out=bizlogic/protoc --proto_path=protobuf protobuf/*.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=
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 [email protected]/command.go:161 error occured in call, closing with error: paths must start with a leading slash
```