goobox / goobox-nodes

📖 API that manages the collection of data and metadata of storage nodes, keep it updated and provides a reliable way to access it

Goobox Nodes

• Project: Goobox
• Author: José Antonio Perdiguero López
• Status: Development

Introduction

Goobox Nodes is a service part of Goobox ecosystem that manages the collection of data and metadata of storage nodes, keep it updated and provides a reliable way to access it.

API Description

Online Documentation

API documentation can be accessed through /docs/ or /redoc/ endpoint, and it will show the full documentation that reflects the current status of the service, gathering every resource and its different methods as well as how to call the endpoint of these methods, including a descriptive list of parameters.

Schema

The schema of the API can be generated following OpenAPI standard calling the /schema/ endpoint:

curl http://localhost:8000/schema/

Contribute

Requirements

• Python.
• Docker.
• Poetry.

Build

Clone repository

git clone https://github.com/goobox/goobox-nodes.git

Install development dependencies

poetry install

Build service image

poetry run python make build

Run

Run the service stack

poetry run python make up

And stop it when you finish

poetry run python make down

Help

The entry point has a self-describing help that can be queried.

poetry run python make run -h

Also, each command has its own help.

poetry run python make run start -h

Code Quality

To check code quality:

poetry run python make run lint

Testing

To run tests manually:

poetry run python make run test

License

GNU GPL v3