معرفی شرکت ها
boaviztapi-0.2.2
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Giving access to BOAVIZTA referenced datas and methodologies trought a RESTful api
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | boaviztapi-0.2.2 |
| نام | boaviztapi |
| نسخه کتابخانه | 0.2.2 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | - |
| آدرس صفحه اصلی | https://github.com/Boavizta/Tools-API |
| آدرس اینترنتی | https://pypi.org/project/boaviztapi/ |
| مجوز | - |
<p align="center">
<img src="https://raw.githubusercontent.com/Boavizta/boaviztapi/dev/boavizta-logo-4.png" width="100">
</p>
<h1 align="center">
Boavizta API
</h1>
---
An API to access [Boavizta's](https://boavizta.cmakers.io/) methodologies and footprint [reference data](https://github.com/Boavizta/environmental-footprint-data).
See the [documentation](https://doc.api.boavizta.org/) for API usage and methodology.
[](https://github.com/Boavizta/boaviztapi/actions/workflows/test.yml)
## :dart: Objective
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.
## :fast_forward: Test it yourself (no installation)
* See our pedagogical front-end app (using the API) : <https://datavizta.boavizta.org/serversimpact>
* See the OpenAPI specification: <https://api.boavizta.org/docs>
* [Documentation](https://doc.api.boavizta.org/)
* Access the demo API: <https://api.boavizta.org>
## Run a local instance
## :whale: Run API using docker
```bash
$ docker run ghcr.io/boavizta/boaviztapi:latest
```
## 📦 Install using pip package
```bash
$ pip3 install boaviztapi
```
## :computer: Development
### Prerequisite
Python 3, pipenv recommended
### Setup pipenv
Install pipenv globally
```bash
$ sudo pip3 install pipenv
```
Install dependencies and create a python virtual environment.
```bash
$ pipenv install -d
$ pipenv shell
```
### Launch a development server
**Once in the pipenv environment**
Development server uses [uvicorn](https://www.uvicorn.org/) and [fastapi](https://fastapi.tiangolo.com/), you can launch development server with the `uvicorn` CLI.
```bash
$ uvicorn boaviztapi.main:app --host=localhost --port 5000
```
You can run the tests with `pytest`.
### Create your own docker image and run it
Build application package
```sh
make install
```
Build docker image
```sh
docker build --build-arg VERSION=0.2.0 -t boavizta/boaviztapi:0.2.0 .
```
Run docker image
```sh
docker run -p 5000:5000/tcp boavizta/boaviztapi:0.2.0
```
### Deploy to AWS as serverless application
Api can be self hosted to your own AWS account using the serverless framework.
```sh
# 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_
### OpenAPI specification (Swagger)
Once API server is launched API swagger is available at [httsp://localhost:5000/docs](https://localhost:5000/docs).
## :woman: Contributing
See [contributing.md](./CONTRIBUTING.md)
You can build a source distribution (installable with pip) with `python setup.py sdist`.
## :one: Versioning
We use [Semantic Versioning 2.0.0](https://semver.org/)
| 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``` |
## :scroll: License
GNU Affero General Public License v3.0
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl boaviztapi-0.2.2:
pip install boaviztapi-0.2.2.whl
نصب پکیج tar.gz boaviztapi-0.2.2:
pip install boaviztapi-0.2.2.tar.gz