2021-2-MeasureSoftGram-Service

Badges

O que é

The MeasureSoftGram-Service is responsible for containing and manipulating MeasureSoftGram data: metrics, configuration goals, analyzes performed, etc. It uses the MVC layer pattern for building and organizing the service.

How to use Service

-How to use

How to run Service

Make the container with :

docker-compose up

Endpoints

## Lista todas as métricas suportadas pelo MeasureSoftGram
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/supported-metrics/

## Detalha o `repository` de ID 1
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/

## Lista o último valor coletado de cada uma das métricas suportadas
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/metrics/

## Lista o último valor coletado de cada um métricas específica
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/metrics/<int>/

## Lista o histórico de valores coletadas de cada uma das métricas suportadas
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/history/metrics/

## Lista o histórico de valores coletadas de uma métrica específica
- GET: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/history/metrics/<int>/

## Coleta um novo valor de uma métrica
- POST: https://measuresoftgram-service.herokuapp.com/api/v1/organizations/1/repository/1/create/metrics/

Acessa o painel administrativo do MeasureSoftGram

GET: https://measuresoftgram-service.herokuapp.com/admin/
Converse com os membros da equipe para socilitar uma credencial de acesso



## How to run tests
Install this dependencies

pip install -r requirements.txt



We are using tox for the tests, so it is good to install the tox:

pip install tox


Then you can run the tests using

tox


if you want to especify the file use:

tox


If it does not work, you can try to run before:

pip install pytest-mock


## Another informations

Our services are available on [Docker Hub](https://hub.docker.com/):
- [Core](https://hub.docker.com/r/measuresoftgram/core)
- [Service](https://hub.docker.com/r/measuresoftgram/service)

### Wiki

For more informations, you can see our wiki:
- [Wiki](https://fga-eps-mds.github.io/2023-1-MeasureSoftGram-Doc/).

## Contribute

Do you want to contribute with our project? Access our [contribution guide](https://github.com/fga-eps-mds/2021-2-MeasureSoftGram-Service/blob/develop/CONTRIBUTING.md) where we explain how you do it.

## License

AGPL-3.0 License

## Documentation

The documentation of this project can be accessed at this website: [Documentation](https://github.com/fga-eps-mds/2023-1-MeasureSoftGram-Doc).