See the documentation for API usage and methodology.

💬 Join us on our public chat

Boavizta aims to enhance the assessment of environmental impacts induced by ICTs in organizations by providing widespread access to our work in an automated and efficient manner.

Boavizta integrates various data and methodologies, which are combined and made accessible through this API.

Transparency and the popularization of scientific knowledge are of utmost importance in this project, and key aspects include open-sourcing the code, versioning the impact factors, and thoroughly documenting the project.

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 follows a bottom-up approach in its development, organized into layers. The initial layer focuses on equipment. The second layer focues on the impacts of digital services (e.g. cloud instances) or systems. However, assessing the overall global impact of ICT is currently beyond the project's 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 -p 5000:5000 ghcr.io/boavizta/boaviztapi:latest

Access the API at http://localhost:5000.

$ pip3 install boaviztapi

Run the server locally with:

$ uvicorn boaviztapi.main:app --host=localhost --port 5000

• Python >=3.12
• Poetry (see the install instructions)
• make

Install dependencies and check the environment is set up correctly:

$ make install
$ make test
$ make lint

The development server uses uvicorn and FastAPI. You can launch the development server with the uvicorn CLI.

# Using uvicorn
$ make run

# Using Python directly (adds watcher)
$ make run-py

You can run the tests with pytest via make test.

Build application package:

make install

Build Docker image:

# using the makefile (recommended)
make docker-build

# manual build (requires to set version)
docker build --build-arg VERSION=`poetry version -s` .

Run Docker image:

docker run -p 5000:5000/tcp boavizta/boaviztapi:`poetry version -s`

make docker-build-development

make docker-run-development

You can self-host BoaviztAPI as an AWS Lambda function using Serverless Framework.

You must first configure:

• AWS CLI
• Serverless Framework CLI

Once done, you can deploy the API with:

serverless deploy

When the deploy succeeds, it will show you the URLs for the deployed function, and you can call the API as normal, e.g.

# Replace the base URL with your own
curl -s "https://k9wllbzcc2.execute-api.eu-west-1.amazonaws.com/v1/server/?archetype=dellR740"

You can check your Lambda URL at any time with:

serverless info

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 make build.

We use Semantic Versioning 2.0.0

See the Release Process wiki.

GNU Affero General Public License v3.0