Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prefeiturasp/SME-PratoAberto-API
API da aplicação PratoAberto
https://github.com/prefeiturasp/SME-PratoAberto-API
Last synced: 3 months ago
JSON representation
API da aplicação PratoAberto
- Host: GitHub
- URL: https://github.com/prefeiturasp/SME-PratoAberto-API
- Owner: prefeiturasp
- License: gpl-3.0
- Created: 2018-03-12T12:39:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-25T11:55:55.000Z (4 months ago)
- Last Synced: 2024-07-25T12:47:44.191Z (4 months ago)
- Language: HTML
- Size: 2.08 MB
- Stars: 18
- Watchers: 27
- Forks: 19
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-social-projects - SME Prato Aberto
README
[](https://codeclimate.com/github/prefeiturasp/SME-PratoAberto-API/maintainability) [](https://travis-ci.org/prefeiturasp/SME-PratoAberto-API)
## Instalação
Instale os requisitos através do `requirements.txt` e configure uma variável de ambiente chamada API_MONGO_URI com o apontamento para a base.
```
pip install -r requirements.txt
export API_MONGO_URI=localhost:27017
FLASK_APP=api.py flask run
```
## Instalação usando Docker
Dentro do diretório do projeto, inicie a aplicação usando `docker-compose`.
`docker-compose up -D --build`
Instale MongoDB versão mínima 3.6:
[Windows](http://treehouse.github.io/installation-guides/windows/mongo-windows.html)
[Mac](http://treehouse.github.io/installation-guides/mac/mongo-mac.html)
```
mongod --fork --logpath
mongorestore -d pratoaberto -c cardapios ./cardapios.bson
mongorestore -d pratoaberto -c escolas ./escolas.bson
```
# Pátio Digital
_“Recurso público retorna ao público”._
Nós somos o **pátio digital**, uma iniciativa da Secretaria Municipal de Educação de São Paulo que, por meio do fortalecimento da transparência, da participação social e do desenvolvimento de novas tecnologias, aproxima diferentes grupos da sociedade civil por um objetivo maior: a melhoria da educação na cidade de São Paulo.
# Prato Aberto
"Prato Aberto – Comida Boa Não Tem Segredo".
# API do Prato Aberto
A API serve dados sobre as escolas e as refeições das escolas da rede pública da cidade de São Paulo.
## Conteúdo
1. [Sobre o prato aberto](#sobre-o-prato-aberto)
2. [Comunicação](#comunicação)
3. [Roadmap de tecnologia](#roadmap-de-tecnologia)
4. [Como contribuir](#como-contribuir)
5. [Instalação](#instalação)
## Sobre o prato aberto
Projetada para funcionar em computadores e dispositivos móveis como tablets e celulares. A ferramenta permite a consulta dos cardápios por dia e por escola, com visualização no mapa. É a primeira vez que os cardápios
são divulgados por unidade escolar. Além de facilitar a consulta dos cardápios,a plataforma permite a avaliação da qualidade das refeições e prevê interação com usuários via Facebook e Telegram, por meio de um assistente virtual, o Robô Edu.
### Nossos outros repositórios
1. [Robô Edu](https://github.com/prefeiturasp/SME-PratoAberto-Edu)
2. [API](https://github.com/prefeiturasp/SME-PratoAberto-API)
3. [Editor](https://github.com/prefeiturasp/SME-PratoAberto-Editor)
## Comunicação
| Canal de comunicação | Objetivos |
|----------------------|-----------|
| [Issues do Github](https://github.com/prefeiturasp/SME-PratoAberto-Frontend/issues) | - Sugestão de novas funcionalidades
- Reportar bugs
- Discussões técnicas |
| [Telegram](https://t.me/patiodigital ) | - Comunicar novidades sobre os projetos
- Movimentar a comunidade
- Falar tópicos que **não** demandem discussões profundas |
Qualquer outro grupo de discussão não é reconhecido oficialmente.
## Roadmap de tecnologia
### Passos iniciais
- Melhorar a qualidade de código
- Iniciar a escrita de testes unitários
- Configurar Docker
- Melhorar documentação de maneira enxuta
- CI com jenkins
## Como contribuir
Contribuições são **super bem vindas**! Se você tem vontade de construir o
prato aberto conosco, veja o nosso [guia de contribuição](./CONTRIBUTING.md)
onde explicamos detalhadamente como trabalhamos e de que formas você pode nos
ajudar a alcançar nossos objetivos. Lembrando que todos devem seguir
nosso [código de conduta](./CODEOFCONDUCT.md).
# Endpoints
## /escolas
Lista escolas da rede publica.
Argumentos de query string:
```
nome: string - opcional
Permite a filtragem da lista de escolas pelo nome
```
Retorno:
```
[
{
"_id": 91065,
"nome": "EMEI ELIS REGINA - (TERCEI.)",
"endereco": "R. ERNESTO MANOGRASSO, 340",
"bairro": "CID. SÃO MATEUS",
"lat": -23.611117,
"lon": -46.479426
},
...
]
```
## /escola/
Lista detalhes de uma determina escola pelo seu identificador (código Escola Online - EOL)
Parametros:
```
id_escola: int
```
Retorno:
```
{
"nome": "EMEI ELIS REGINA - (TERCEI.)",
"tipo_unidade": "EMEI",
"tipo_atendimento": "TERCEIRIZADA",
"agrupamento": 4,
"endereco": "R. ERNESTO MANOGRASSO, 340",
"bairro": "CID. SÃO MATEUS",
"telefone": "(11)29199960",
"lat": -23.611117,
"lon": -46.479426,
"idades": [
"Z - UNIDADES SEM FAIXA"
]
}
```
## /cardapios ou /cardapios/
Lista os cardapios disponíveis
Parametros:
```
data: string - opcional
Formato: YYYYMMDD
```
Argumentos de query string:
```
agrupamento: string - opcional
tipo_atendimento: string - opcional
tipo_unidade: string - opcional
idade: string - opcional
data_inicial: string - opcional
data_final: string - opcional
```
Retorno:
```
[
{
"data": "20170922",
"idade": "1 A 3 MESES",
"tipo_atendimento": "DIRETA",
"tipo_unidade": "CEI_CONVENIADO",
"agrupamento": "4",
"cardapio": {
"Jantar": [
"FORMULA LÁCTEA"
],
"Desjejum": [
"FORMULA LACTEA"
],
"Almoco": [
"FORMULA LACTEA"
],
"Lanche": [
"FORMULA LÁCTEA"
]
},
},
...
]
```
## /editor/cardapios
Permite a listagem e a alteração dos dados de cardápio.
Para acesso, é necessário enviar uma chave através do cabeçalho HTTP `key`. A chave deve ser a mesma que a variável de ambiente `API_KEY`
Argumentos de query string:
```
status: string - opcional
agrupamento: string - opcional
tipo_atendimento: string - opcional
tipo_unidade: string - opcional
idade: string - opcional
data_inicial: string - opcional
data_final: string - opcional
```
Retorno:
```
[
{
"data": "20170922",
"idade": "1 A 3 MESES",
"tipo_atendimento": "DIRETA",
"tipo_unidade": "CEI_CONVENIADO",
"agrupamento": "4",
"cardapio": {
"Jantar": [
"FORMULA LÁCTEA"
],
"Desjejum": [
"FORMULA LACTEA"
],
"Almoco": [
"FORMULA LACTEA"
],
"Lanche": [
"FORMULA LÁCTEA"
]
},
},
...
]
```
## /status
Verifica se a API está online.
Retorno:
```
{
"status": "ativo"
}
```
Baseado no Readme do [i-educar](https://github.com/portabilis/i-educar)