Data

Tools

Indexes

Applications

Experiments

Open Sustainable Technology

BoaviztAPI

API to expose the BOAVIZTA reference data and methodologies to allow full life cycle / multi-criteria environmental impact assessments of software.
https://github.com/Boavizta/boaviztapi

Category: Consumption
Sub Category: Computation and Communication

Keywords

openapi

Keywords from Contributors

sustainability virtual-machine carbon-footprint boavizta greenit energy-consumption watts wattmeter qemu measure

Last synced: about 11 hours ago
JSON representation

Repository metadata

🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API

README.md

See the documentation for API usage and methodology.

Python tests

💬 Join us on our public chat

🎯 Objective

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.

⏩ Test it yourself (no installation)

Run a local instance

🐳 Run API using docker

$ docker run -p 5000:5000 ghcr.io/boavizta/boaviztapi:latest

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

💻 Development

Prerequisite

Setup poetry

Install dependencies and check the environment is set up correctly:

$ make install
$ make test
$ make lint

Launch a development server

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

Tests

You can run the tests with pytest via:

  • make test to run all unit tests (using test data)
  • make test-e2e to run end-to-end tests (using "real" data)

Create your own docker image and run it

Build Docker image:

# Using the makefile (recommended)
make docker-build-development
make docker-run-development

# Manual build
docker build . -t boavizta-test
docker run -p 5000:5000 boavizta-test

Deploy to AWS as serverless application

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

You must first configure:

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

OpenAPI specification (Swagger)

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

👩 Contributing

See contributing.md.

You can build a source distribution (installable with pip) with make build.

1️⃣ Versioning

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

2️⃣ Releasing

See the Release Process wiki.

📜 License

GNU Affero General Public License v3.0

Owner metadata

GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 1,116
Total Committers: 31
Avg Commits per committer: 36.0
Development Distribution Score (DDS): 0.789

Commits in past year: 75
Committers in past year: 10
Avg Commits per committer in past year: 7.5
Development Distribution Score (DDS) in past year: 0.733

Name Email Commits
da-ekchajzer d****r@L****k 235
David Ekchajzer d****r@h****g 210
Samuel Rince s@r****e 152
da-ekchajzer d****r@g****m 105
Benoit Petit b****t@h****g 98
olivier de Meringo d****o@g****m 41
Simon Shillaker 5****r 36
Samuel s****l@a****e 30
Bruno Thomas b****o@b****r 27
dependabot[bot] 4****] 24
Benjamin Dromard b****d@g****m 24
Jonathan Perron j****n@p****h 22
Jacob Valdemar Andreasen j****n@l****p 21
Airloren r****n@c****o 20
benjaminlebigot b****t@g****m 12
Julien Nioche j****n@d****m 10
Christophe Saugé c****e@g****m 8
github-actions[bot] 4****] 6
Thibault Simon t****n@o****m 5
Valentin Chaud v****d@o****m 5
ju3ouz4n j****n@p****e 5
Luke Kuzmish l****h@g****m 5
Olivier D o****i@g****m 4
Seb Solere s****e 2
Vincent Doré-Millet v****t@u****m 2
DE MERINGO Olivier o****o@c****m 2
JX5671 1****7@g****m 1
Pierre Rust p****t@g****m 1
Wojciech WOJCIK w****k@o****m 1
Vincent Villet v****t@g****m 1
and 1 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 4 days ago

Total issues: 166
Total pull requests: 256
Average time to close issues: 5 months
Average time to close pull requests: 11 days
Total issue authors: 29
Total pull request authors: 25
Average comments per issue: 2.38
Average comments per pull request: 0.94
Merged pull request: 197
Bot issues: 0
Bot pull requests: 37

Past year issues: 20
Past year pull requests: 77
Past year average time to close issues: 17 days
Past year average time to close pull requests: 11 days
Past year issue authors: 12
Past year pull request authors: 10
Past year average comments per issue: 1.1
Past year average comments per pull request: 0.45
Past year merged pull request: 41
Past year bot issues: 0
Past year bot pull requests: 15

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/Boavizta/boaviztapi

Top Issue Authors

  • da-ekchajzer (52)
  • demeringo (50)
  • bpetit (8)
  • jnioche (7)
  • VincentVillet (5)
  • Shillaker (5)
  • davidkopp (4)
  • jonperron (4)
  • JacobValdemar (3)
  • PierreRust (3)
  • samuelrince (3)
  • PierreRustOrange (2)
  • mrchrisadams (2)
  • damienfernandes (2)
  • ValentinRegnault (2)

Top Pull Request Authors

  • da-ekchajzer (76)
  • dependabot[bot] (37)
  • Shillaker (30)
  • demeringo (19)
  • jonperron (17)
  • ju3ouz4n (16)
  • csauge (9)
  • tibosmn (7)
  • samuelrince (6)
  • jnioche (6)
  • AirLoren (5)
  • JacobValdemar (4)
  • bpetit (4)
  • valentinchaud (3)
  • bamthomas (2)

Top Issue Labels

  • bug (49)
  • enhancement (32)
  • help wanted (25)
  • documentation (23)
  • good first issue (20)
  • functional (16)
  • DATA (14)
  • methodology (13)
  • technical (7)
  • dependencies (2)
  • python (2)
  • security (2)
  • question (1)
  • use case (1)
  • ci (1)

Top Pull Request Labels

  • dependencies (37)
  • python (31)
  • DATA (7)
  • javascript (6)
  • documentation (3)
  • enhancement (2)
  • bug (2)

Package metadata

proxy.golang.org: github.com/Boavizta/boaviztapi

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/Boavizta/boaviztapi#section-documentation
  • Licenses: agpl-3.0
  • Latest release: v2.0.2+incompatible (published 5 days ago)
  • Last Synced: 2026-02-05T02:07:39.131Z (3 days ago)
  • Versions: 36
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.401%
    • Average: 5.583%
    • Dependent repos count: 5.764%
proxy.golang.org: github.com/boavizta/boaviztapi

  • Homepage:
  • Documentation: https://pkg.go.dev/github.com/boavizta/boaviztapi#section-documentation
  • Licenses: agpl-3.0
  • Latest release: v2.0.2+incompatible (published 5 days ago)
  • Last Synced: 2026-02-05T02:07:42.190Z (3 days ago)
  • Versions: 36
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Rankings:
    • Dependent packages count: 5.401%
    • Average: 5.583%
    • Dependent repos count: 5.764%
pypi.org: boaviztapi-sdk

BoaviztAPI SDK for Python applications.

  • Homepage:
  • Documentation: https://boaviztapi-sdk.readthedocs.io/
  • Licenses:
  • Latest release: 2.0.2 (published 5 days ago)
  • Last Synced: 2026-02-05T02:07:38.922Z (3 days ago)
  • Versions: 18
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 410 Last month
  • Rankings:
    • Dependent packages count: 9.995%
    • Dependent repos count: 21.728%
    • Average: 21.764%
    • Downloads: 33.568%
  • Maintainers (1)
pypi.org: boaviztapi

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

  • Homepage:
  • Documentation: https://boaviztapi.readthedocs.io/
  • Licenses: agpl-3.0
  • Latest release: 2.0.2 (published 5 days ago)
  • Last Synced: 2026-02-05T02:07:27.178Z (3 days ago)
  • Versions: 36
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 891 Last month
  • Rankings:
    • Dependent packages count: 9.995%
    • Downloads: 26.287%
    • Average: 34.62%
    • Dependent repos count: 67.577%
  • Maintainers (1)

Dependencies

package-lock.json npm
  • 2-thenable 1.0.0
  • @iarna/toml 2.2.5
  • ansi-regex 5.0.1
  • ansi-styles 4.3.0
  • appdirectory 0.1.0
  • at-least-node 1.0.0
  • balanced-match 1.0.2
  • bluebird 3.7.2
  • brace-expansion 1.1.11
  • camelcase 5.3.1
  • child-process-ext 2.1.1
  • cliui 6.0.0
  • color-convert 2.0.1
  • color-name 1.1.4
  • concat-map 0.0.1
  • core-util-is 1.0.3
  • cross-spawn 6.0.5
  • d 1.0.1
  • decamelize 1.2.0
  • duration 0.2.2
  • emoji-regex 8.0.0
  • es5-ext 0.10.61
  • es6-iterator 2.0.3
  • es6-symbol 3.1.3
  • event-emitter 0.3.5
  • ext 1.6.0
  • find-up 4.1.0
  • fs-extra 9.1.0
  • fs.realpath 1.0.0
  • get-caller-file 2.0.5
  • glob 7.2.3
  • glob-all 3.3.0
  • graceful-fs 4.2.10
  • immediate 3.0.6
  • inflight 1.0.6
  • inherits 2.0.4
  • is-docker 2.2.1
  • is-fullwidth-code-point 3.0.0
  • is-plain-object 2.0.4
  • is-primitive 3.0.1
  • is-stream 1.1.0
  • is-wsl 2.2.0
  • isarray 1.0.0
  • isexe 2.0.0
  • isobject 3.0.1
  • jsonfile 6.1.0
  • jszip 3.10.0
  • lie 3.3.0
  • locate-path 5.0.0
  • lodash.get 4.4.2
  • lodash.uniqby 4.7.0
  • lodash.values 4.3.0
  • log 6.3.1
  • minimatch 3.1.2
  • next-tick 1.1.0
  • nice-try 1.0.5
  • once 1.4.0
  • p-limit 2.3.0
  • p-locate 4.1.0
  • p-try 2.2.0
  • pako 1.0.11
  • path-exists 4.0.0
  • path-is-absolute 1.0.1
  • path-key 2.0.1
  • process-nextick-args 2.0.1
  • readable-stream 2.3.7
  • readable-stream 3.6.0
  • require-directory 2.1.1
  • require-main-filename 2.0.0
  • rimraf 3.0.2
  • safe-buffer 5.1.2
  • safe-buffer 5.2.1
  • semver 5.7.1
  • serverless-python-requirements 5.4.0
  • set-blocking 2.0.0
  • set-value 4.1.0
  • setimmediate 1.0.5
  • sha256-file 1.0.0
  • shebang-command 1.2.0
  • shebang-regex 1.0.0
  • shell-quote 1.7.3
  • split2 3.2.2
  • sprintf-kit 2.0.1
  • stream-promise 3.2.0
  • string-width 4.2.3
  • string_decoder 1.1.1
  • string_decoder 1.3.0
  • strip-ansi 6.0.1
  • type 2.6.0
  • type 1.2.0
  • uni-global 1.0.0
  • universalify 2.0.0
  • util-deprecate 1.0.2
  • which 1.3.1
  • which-module 2.0.0
  • wrap-ansi 6.2.0
  • wrappy 1.0.2
  • y18n 4.0.3
  • yargs 15.4.1
  • yargs-parser 18.1.3
package.json npm
  • serverless-python-requirements ^5.0.1
.github/workflows/github_page_deploy.yml actions
  • actions/checkout v2 composite
  • ad-m/github-push-action master composite
  • mhausenblas/mkdocs-deploy-gh-pages master composite
.github/workflows/release.yml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • docker/login-action v1 composite
.github/workflows/test.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
Dockerfile docker
  • gcr.io/distroless/python3 latest build
  • python 3.9-slim build
docs/Dockerfile docker
  • python 3.7-slim-buster build
docs/requirements.txt pypi
  • markdown ==3.2.1
  • mkdocs *
  • mkdocs-material ==8.5.6
  • mkdocs-render-swagger-plugin *
requirements.txt pypi
  • CacheControl ==0.12.11
  • Jinja2 ==3.1.2
  • Markdown ==3.4.1
  • MarkupSafe ==2.1.1
  • PyYAML ==6.0
  • Pygments ==2.13.0
  • aiofile ==3.8.1
  • anyio ==3.6.2
  • atomicwrites ==1.4.1
  • attrs ==22.1.0
  • bleach ==5.0.1
  • bump2version ==1.0.1
  • caio ==0.9.11
  • certifi ==2022.9.24
  • cffi ==1.15.1
  • charset-normalizer ==2.1.1
  • click ==8.1.3
  • colorama ==0.4.6
  • commonmark ==0.9.1
  • cryptography ==38.0.4
  • cyclonedx-python-lib ==3.1.1
  • docutils ==0.19
  • exceptiongroup ==1.0.4
  • fastapi ==0.88.0
  • ghp-import ==2.1.0
  • h11 ==0.14.0
  • html5lib ==1.1
  • httpcore ==0.16.2
  • httpx ==0.23.1
  • idna ==3.4
  • importlib-metadata ==5.1.0
  • iniconfig ==1.1.1
  • jaraco.classes ==3.2.3
  • keyring ==23.11.0
  • lockfile ==0.12.2
  • mangum ==0.17.0
  • mergedeep ==1.3.4
  • mkdocs *
  • mkdocs-material *
  • mkdocs-material-extensions *
  • mkdocs-render-swagger-plugin *
  • more-itertools ==9.0.0
  • msgpack ==1.0.4
  • numpy ==1.23.5
  • packageurl-python ==0.10.4
  • packaging ==21.3
  • pandas ==1.5.2
  • pip-api ==0.0.30
  • pip-requirements-parser ==32.0.0
  • pip_audit ==2.4.10
  • pkginfo ==1.9.2
  • pluggy ==1.0.0
  • pycparser ==2.21
  • pydantic ==1.10.2
  • pymdown-extensions ==9.9
  • pyparsing ==3.0.9
  • pytest ==7.2.0
  • pytest-asyncio ==0.20.2
  • python-dateutil ==2.8.2
  • pytz ==2022.6
  • pyyaml_env_tag ==0.1
  • rapidfuzz ==2.13.3
  • readme-renderer ==37.3
  • requests ==2.28.1
  • requests-toolbelt ==0.10.1
  • resolvelib ==0.9.0
  • rfc3986 ==1.5.0
  • rich ==12.6.0
  • scipy ==1.9.3
  • setuptools-pipfile ==0.4.1
  • six ==1.16.0
  • sniffio ==1.3.0
  • sortedcontainers ==2.4.0
  • starlette ==0.22.0
  • toml ==0.10.2
  • tomli ==2.0.1
  • tqdm ==4.64.1
  • twine ==3.2.0
  • typing_extensions ==4.4.0
  • urllib3 ==1.26.13
  • uvicorn ==0.20.0
  • watchdog ==2.2.0
  • webencodings ==0.5.1
  • zipp ==3.11.0
boaviztapi/data/utils/complete_AWS_EC2/go.mod go
poetry.lock pypi
  • aiofile 3.8.7
  • anyio 3.7.0
  • atomicwrites 1.4.1
  • babel 2.13.0
  • caio 0.9.12
  • certifi 2023.5.7
  • charset-normalizer 3.1.0
  • click 8.1.3
  • colorama 0.4.6
  • exceptiongroup 1.1.1
  • fastapi 0.95.2
  • ghp-import 2.1.0
  • h11 0.14.0
  • httpcore 0.17.2
  • httpx 0.24.1
  • idna 3.4
  • importlib-metadata 6.6.0
  • iniconfig 2.0.0
  • jinja2 3.1.2
  • mangum 0.17.0
  • markdown 3.4.3
  • markupsafe 2.1.3
  • mergedeep 1.3.4
  • mkdocs 1.5.3
  • mkdocs-macros-plugin 1.0.4
  • mkdocs-material 9.4.4
  • mkdocs-material-extensions 1.2
  • mkdocs-render-swagger-plugin 0.1.0
  • numpy 1.24.3
  • packaging 23.1
  • paginate 0.5.6
  • pandas 2.0.2
  • pathspec 0.11.2
  • platformdirs 3.11.0
  • pluggy 1.0.0
  • pydantic 1.10.9
  • pygments 2.16.1
  • pymdown-extensions 10.3
  • pytest 7.3.1
  • pytest-asyncio 0.21.0
  • python-dateutil 2.8.2
  • pytz 2023.3
  • pyyaml 6.0
  • pyyaml-env-tag 0.1
  • rapidfuzz 3.1.1
  • regex 2023.10.3
  • requests 2.31.0
  • scipy 1.9.3
  • six 1.16.0
  • sniffio 1.3.0
  • starlette 0.27.0
  • termcolor 2.3.0
  • toml 0.10.2
  • tomli 2.0.1
  • typing-extensions 4.6.3
  • tzdata 2023.3
  • urllib3 2.0.3
  • uvicorn 0.22.0
  • watchdog 3.0.0
  • zipp 3.15.0
pyproject.toml pypi
  • aiofile ^3.8
  • fastapi ^0.95
  • importlib-metadata ^6.6.0
  • mangum ^0.17
  • markdown ^3.4
  • numpy ^1.24
  • pandas ^2.0
  • pydantic ^1.10
  • python ^3.8
  • pyyaml ^6.0
  • rapidfuzz ^3.0
  • scipy ^1.9
  • toml ^0.10.2
  • uvicorn ^0.22
.github/workflows/check_markdown_links.yaml actions
  • actions/checkout main composite
  • byrnereese/github-action-mkdocs-link-check 1.0 composite
.github/workflows/generate_requirements_for_clever_cloud.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
boaviztapi/data/utils/complete_Azure_VMs/requirements.txt pypi
  • pandas *
boaviztapi/data/utils/complete_Scaleway_Instances/requirements.txt pypi
  • requests ==2.32.4

Score: 15.482376270172896