{"id":13521119,"url":"https://github.com/Boavizta/boaviztapi","last_synced_at":"2025-03-31T20:30:43.348Z","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":"2025-03-24T18:02:16.000Z","size":7560,"stargazers_count":81,"open_issues_count":38,"forks_count":29,"subscribers_count":13,"default_branch":"main","last_synced_at":"2025-03-27T12:01:20.567Z","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}},"created_at":"2021-11-09T16:22:53.000Z","updated_at":"2025-03-26T10:25:28.000Z","dependencies_parsed_at":"2024-04-09T16:41:59.329Z","dependency_job_id":"40b8858f-c2f7-4ee8-9571-d8376a8bdabf","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":33,"template":false,"template_full_name":null,"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","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245972692,"owners_count":20702721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-08-01T06:00:28.901Z","updated_at":"2025-03-31T20:30:43.336Z","avatar_url":"https://github.com/Boavizta.png","language":"Python","funding_links":[],"categories":["🛠 Tools","Consumption"],"sub_categories":["Calculation Tools","Computation and Communication"],"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\nPython 3 mandatory, Python \u003e=3.10 and [Poetry](https://python-poetry.org/) strongly recommended.\n\n### Setup poetry\n\nInstall poetry (see the [install instructions](https://python-poetry.org/docs/) for more details):\n\n```bash\n$ pip3 install poetry\n```\n\nInstall dependencies and create a Python virtual environment:\n\n```bash\n$ make install\n$ poetry shell\n```\n\n### Launch a development server\n\n**Once in the poetry environment**\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$ uvicorn boaviztapi.main:app --host=localhost --port 5000\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\n⚠ This is currently not working , see  [Deployment as serverless application does not work · Issue #153 · Boavizta/boaviztapi](https://github.com/Boavizta/boaviztapi/issues/153)\n\nApi can be self hosted to your own AWS account using the serverless framework.\n\n```sh\n# Install the serverless framework and plugins\nnpm install -g serverless\nnpm i\n# Authenticate\nexport AWS_PROFILE=your-own-profile\n# Deploy to dev\nserverless deploy\n```\n\n_Fisrt packaging/deployment may takes a several minutes_\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\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: Publishing\n\nYou can run:\n\n```shell\nAPI_TOKEN=\u003cyour_token\u003e make distribute\n```\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"}