https://github.com/golemfactory/ya-py-aioclient
https://github.com/golemfactory/ya-py-aioclient
golem
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/golemfactory/ya-py-aioclient
- Owner: golemfactory
- Fork: true (prekucki/ya-py-aioclient)
- Created: 2020-07-22T12:42:04.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-24T14:08:28.000Z (about 2 years ago)
- Last Synced: 2024-10-01T04:28:44.313Z (over 1 year ago)
- Topics: golem
- Language: Python
- Homepage:
- Size: 1.01 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# YA-PY-AIOClient
Python Rest binding of [Yapapi](https://github.com/golemfactory/yapapi), generated by [Open Api Generator](https://github.com/OpenAPITools/openapi-generator/) and several patches.
## Prerequisites
- Python 3.6+
- Poetry
- [Poe](https://github.com/nat-n/poethepoet/blob/e8451601c81a2dfd6066cd02116f07fd7172625b/README.rst) (Optional)
## How to generate
Type and hit to `make setup` then `make m.pre-stub` on terminal, that's it.
Note: Be sure you cleaned around with `make clean` before generating over again.
## Build
`poetry build`
## Run test
After you [generate](#how-to-generate);
`poetry run pytest src`
## Need more patching?
Run `make setup` only.
Then copy content of `src` into `target` (yes replace them all), then do your changes under `src`.
When you done with your changes, run;
```bash
poe diff COMPONENT_NAME COMPONENT_NAME/00X_PATCH_TITLE.patch
```
or (without poe)
```bash
./build-scripts/diff-module.sh COMPONENT_NAME > patches/COMPONENT_NAME/00X_PATCH_TITLE.patch
```
where;
- COMPONENT_NAME: (activity | market | payment | net) depend on component you patch
- PATCH_TITLE: give a descriptive title to your patch
- 00X: order number of patch