Giving access to BOAVIZTA referenced datas and methodologies trought a RESTful api
Project description
BOAVIZTAPI
Giving access to BOAVIZTA referenced datas and methodologies trought a RESTful API
:dart: Objective
As part of Boavizta's desire to improve the quality of the measurement of the environmental impacts of ICTs in organizations, this project aims at giving access to the group's work to as many people as possible in an automated and industrialized way.
The various data and methodologies integrated by Boavizta are aggregated and made available via an API.
In the interest of transparency and scientific popularization, the opening of the code, the versioning of the impact factors and the documentation of the project are critical points.
The system is developed in layers according to a bottom-up principle. The first layer implemented is equipment, starting with the servers (MVP). The second layer is the measurement of the impact of digital services or systems. The measurement of the global impact is currently outside the scope.
:fast_forward: Test it yourself
-
Test the API (on local environment only) : http://149.202.161.61:5000/docs
-
Dev documentation server : http://149.202.161.61/
-
Dev API server: http://149.202.161.61:5000
:computer: Setup project locally with pipenv
Setup pipenv
Install pipenv globally
$ sudo pip3 install pipenv
Install dependencies and create a python virtual environment.
$ pipenv install -d
$ pipenv shell
Launch a development server
Once in the pipenv environment
Development server uses uvicorn and fastapi, you can launch development server with the uvicorn
CLI.
$ uvicorn boaviztapi.main:app --host=localhost --port 5000
You can run the tests with pytest
.
API Swagger
Once API server is launched API swagger is available at http://localhost:5000/docs.
:whale: Install using docker container
$ docker run ghcr.io/boavizta/boaviztapi:latest
📦 Install using pip package
$ pip3 install boaviztapi
:woman: Contributing
See contributing.md
You can build a source distribution (installable with pip) with python setup.py sdist
.
:one: Versionning
We use Semantic Versioning 2.0.0
Type | Description | Command |
---|---|---|
MAJOR | version when you make incompatible API changes | make major |
MINOR | version when you add functionality in a backwards compatible manner | make minor |
PATCH | version when you make backwards compatible bug fixes | make patch |
:scroll: License
TODO
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.