An API to access Boavizta's methodologies and footprint reference data.

See the documentation for API usage and methodology.

💬 Join us on our public chat

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.

• See our pedagogical front-end app (using the API) : https://datavizta.boavizta.org/serversimpact

• See the OpenAPI specification: https://api.boavizta.org/docs

• Documentation

• Access the demo API: https://api.boavizta.org

$ docker run ghcr.io/boavizta/boaviztapi:latest

$ pip3 install boaviztapi

Python 3, pipenv recommended

Install pipenv globally

$ sudo pip3 install pipenv

Install dependencies and create a python virtual environment.

$ pipenv install -d
$ pipenv shell

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.

Build application package

make install

Build docker image

docker build --build-arg VERSION=0.2.0 -t boavizta/boaviztapi:0.2.0 .

Run docker image

docker run -p 5000:5000/tcp boavizta/boaviztapi:0.2.0

Api can be self hosted to your own AWS account using the serverless framework.

# Install the serverless framework and plugins
npm install -g serverless
npm i
# Authenticate
export AWS_PROFILE=your-own-profile
# Deploy to dev
serverless deploy

Fisrt packaging/deployment may takes a several minutes

Once API server is launched API swagger is available at httsp://localhost:5000/docs.

See contributing.md

You can build a source distribution (installable with pip) with python setup.py sdist.

We use Semantic Versioning 2.0.0

GNU Affero General Public License v3.0