{"id":15022250,"url":"https://github.com/boavizta/boaviztapi","last_synced_at":"2026-01-29T16:01:34.992Z","repository":{"id":37779109,"uuid":"426302385","full_name":"Boavizta/boaviztapi","owner":"Boavizta","description":"🛠 Giving access to BOAVIZTA reference data and methodologies trough a RESTful API","archived":false,"fork":false,"pushed_at":"2026-01-26T15:58:35.000Z","size":7789,"stargazers_count":90,"open_issues_count":41,"forks_count":31,"subscribers_count":12,"default_branch":"main","last_synced_at":"2026-01-27T03:54:34.934Z","etag":null,"topics":["openapi"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Boavizta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-11-09T16:22:53.000Z","updated_at":"2026-01-26T15:53:46.000Z","dependencies_parsed_at":"2025-11-23T10:02:21.601Z","dependency_job_id":null,"html_url":"https://github.com/Boavizta/boaviztapi","commit_stats":{"total_commits":893,"total_committers":29,"mean_commits":30.79310344827586,"dds":0.736842105263158,"last_synced_commit":"0a93f9e31e0e8ed6e6df54ba6630242944607169"},"previous_names":["boavizta/tools-api"],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/Boavizta/boaviztapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Boavizta%2Fboaviztapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Boavizta%2Fboaviztapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Boavizta%2Fboaviztapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Boavizta%2Fboaviztapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Boavizta","download_url":"https://codeload.github.com/Boavizta/boaviztapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Boavizta%2Fboaviztapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28880841,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T10:31:27.438Z","status":"ssl_error","status_checked_at":"2026-01-29T10:31:01.017Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi"],"created_at":"2024-09-24T19:57:41.985Z","updated_at":"2026-01-29T16:01:34.984Z","avatar_url":"https://github.com/Boavizta.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/Boavizta/boaviztapi/blob/main/boaviztapi_color.svg\" height=\"100\" alt=\"BoaviztAPI\"\u003e\n\u003c/p\u003e\n\n\u003ch3 align=\"center\"\u003e\n   An API to access \u003ca href=\"https://boavizta.cmakers.io/\"\u003eBoavizta's\u003c/a\u003e methodologies and data\u003c/a\u003e\n\u003c/h3\u003e\n\n---\n\nSee the [documentation](https://doc.api.boavizta.org/) for API usage and methodology.\n\n[![Python tests](https://github.com/Boavizta/boaviztapi/actions/workflows/test.yml/badge.svg)](https://github.com/Boavizta/boaviztapi/actions/workflows/test.yml)\n\n💬 [Join us on our public chat](https://chat.boavizta.org/signup_user_complete/?id=97a1cpe35by49jdc66ej7ktrjc)\n\n## :dart: Objective\n\nBoavizta 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.\n\nBoavizta integrates various data and methodologies, which are combined and made accessible through this API.\n\nTransparency 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.\n\nIn 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.\n\nThe 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.\n\n## :fast_forward: Test it yourself (no installation)\n\n* See our pedagogical front-end app (using the API): \u003chttps://datavizta.boavizta.org/serversimpact\u003e\n\n* See the OpenAPI specification: \u003chttps://api.boavizta.org/docs\u003e\n\n* [Documentation](https://doc.api.boavizta.org/)\n\n* Access the demo API: \u003chttps://api.boavizta.org\u003e\n\n## Run a local instance\n\n### :whale: Run API using docker\n\n```bash\n$ docker run -p 5000:5000 ghcr.io/boavizta/boaviztapi:latest\n```\n\nAccess the API at http://localhost:5000.\n\n### Install using pip package\n\n```bash\n$ pip3 install boaviztapi\n```\n\nRun the server locally with:\n\n```bash\n$ uvicorn boaviztapi.main:app --host=localhost --port 5000\n```\n\n## :computer: Development\n\n### Prerequisite\n\n- Python \u003e=3.12\n- [Poetry](https://python-poetry.org/) (see the [install instructions](https://python-poetry.org/docs/))\n- `make`\n\n### Setup poetry\n\nInstall dependencies and check the environment is set up correctly:\n\n```bash\n$ make install\n$ make test\n$ make lint\n```\n\n### Launch a development server\n\nThe development server uses [uvicorn](https://www.uvicorn.org/) and [FastAPI](https://fastapi.tiangolo.com/). You can launch the development server with the `uvicorn` CLI.\n\n```bash\n# Using uvicorn\n$ make run\n\n# Using Python directly (adds watcher)\n$ make run-py\n```\n\nYou can run the tests with `pytest` via `make test`.\n\n### Create your own docker image and run it\n\nBuild application package:\n\n```sh\nmake install\n```\n\nBuild Docker image:\n\n```sh\n# using the makefile (recommended)\nmake docker-build\n\n# manual build (requires to set version)\ndocker build --build-arg VERSION=`poetry version -s` .\n```\n\nRun Docker image:\n\n```sh\ndocker run -p 5000:5000/tcp boavizta/boaviztapi:`poetry version -s`\n```\n\n#### Alternative (if you don't have Python or Poetry)\n\n```sh\nmake docker-build-development\n\nmake docker-run-development\n```\n\n### Deploy to AWS as serverless application\n\nYou can self-host BoaviztAPI as an AWS Lambda function using [Serverless Framework](https://www.serverless.com/framework).\n\nYou must first configure:\n\n- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html)\n- [Serverless Framework CLI](https://www.serverless.com/framework/docs/getting-started)\n\nOnce done, you can deploy the API with:\n\n```sh\nserverless deploy\n```\n\nWhen the deploy succeeds, it will show you the URLs for the deployed function, and you can call the API as normal, e.g.\n\n```sh\n# Replace the base URL with your own\ncurl -s \"https://k9wllbzcc2.execute-api.eu-west-1.amazonaws.com/v1/server/?archetype=dellR740\"\n```\n\nYou can check your Lambda URL at any time with:\n\n```sh\nserverless info\n```\n\n### OpenAPI specification (Swagger)\n\nOnce API server is launched API swagger is available at [httsp://localhost:5000/docs](https://localhost:5000/docs).\n\n## :woman: Contributing\n\nSee [contributing.md](./CONTRIBUTING.md).\n\nYou can build a source distribution (installable with pip) with `make build`.\n\n## :one: Versioning\n\nWe use [Semantic Versioning 2.0.0](https://semver.org/)\n\n|    Type     | Description                                                          |    Command        |\n| :---        |    :----:                                                            |              ---: |\n| MAJOR       | version when you make incompatible API changes                       | ```make major```  |\n| MINOR       | version when you add functionality in a backwards compatible manner  | ```make minor```  |\n| PATCH       | version when you make backwards compatible bug fixes                 | ```make patch```  |\n\n## :two: Releasing\n\nSee the [Release Process wiki](https://github.com/Boavizta/boaviztapi/wiki/Release-Process).\n\n## :scroll: License\n\nGNU Affero General Public License v3.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboavizta%2Fboaviztapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboavizta%2Fboaviztapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboavizta%2Fboaviztapi/lists"}