https://github.com/golemfactory/golem-core-python
https://github.com/golemfactory/golem-core-python
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/golemfactory/golem-core-python
- Owner: golemfactory
- License: gpl-3.0
- Created: 2022-08-29T15:20:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T14:11:05.000Z (over 1 year ago)
- Last Synced: 2024-05-29T05:58:56.038Z (over 1 year ago)
- Language: Python
- Size: 762 KB
- Stars: 3
- Watchers: 8
- Forks: 2
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Golem Core
## Install
This project uses [Poetry](https://python-poetry.org/) for management, which needs to be installed to run following instructions.
Checkout the repository and run:
```bash
poetry install
```
## Examples
To run examples you need invoke them via poetry:
```bash
poetry run python examples/rate_providers/rate_providers.py
```
## CLI
```bash
python -m golem status
python -m golem find-node --runtime vm
python -m golem find-node --runtime vm --subnet public-beta
python -m golem find-node --runtime vm --timeout 7 # stops after 7 seconds
python -m golem find-node --runtime vm --timeout 1m # stops after 60 seconds
python -m golem allocation list
python -m golem allocation new 1
python -m golem allocation new 2 --driver erc20 --network holesky
python -m golem allocation clean
```
## Docs
To build docs run following commands:
```bash
poetry run poe sphinx
```
Then you can open `build/api.html` file in your web browser.
## Contributing
### Running code auto format
```bash
poetry run poe format
```
### Running code checks
```bash
poetry run poe checks
```
### Running tests
Unit tests:
```bash
poetry run poe tests_unit
```
Integration tests (requires running local `yagna` in requestor mode or `goth` in interactive mode):
```bash
poetry run poe tests_integration
```