Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thepabloaguilar/pharmacy_stock
https://github.com/thepabloaguilar/pharmacy_stock
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/thepabloaguilar/pharmacy_stock
- Owner: thepabloaguilar
- Created: 2019-01-22T18:22:22.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T01:33:23.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T13:57:23.241Z (about 2 months ago)
- Language: Python
- Size: 329 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pharmacy Stock API
Aplicação para gerenciar o estoque de uma farmacia, provendo os seguintes recursos:
- Usuários:
- Existem dois tipos de usuários, os Adminitradores e os Não Adminitradores
- Os Não Administradores não podem interagir com algumas partes do sistema
- Fornecedores
- Medicamentos
- Clientes
- Vendas
## Utilização
### Tecnologias Utilizadas
* [**Python**](https://www.python.org)
* [**Flask**](http://flask.pocoo.org)
* [**Flask RESTFul**](https://flask-restful.readthedocs.io/en/latest/)
* [**Flasgger**](https://github.com/rochacbruno/flasgger)
* [**PostgreSQL**](https://www.postgresql.org)
* [**Docker**](https://www.docker.com)
### Requisitos
* [**Docker**](https://www.docker.com)
* [**Docker Compose**](https://docs.docker.com/compose/install/)
### Subindo o sistema
1. Clone ou faça o download deste repositório.
2. Dentro da pasta execute o seguinte comando para subir os containers:
```sh
make start
```
3. Entre no link [**localhost:5000/docs**](http://localhost:5000/docs).
Esse link dará o acesso ao Swagger onde você poderá fazer requisições para os EndPoints dos serviços.
4. Para parar os serviços, basta executar o seguinte comando no terminal, ainda dentro da pasta do projeto:
```sh
make stop
```
### Utilizando o Swagger
Se você ainda não acessou o link da [**documentação**](http://localhost:5000/docs), acesse.
Todas as rotas, exceto a de login, exigem um **token** para autenticação no HEADER da request. Esse token é obtido através da rota de Login.
#### Pegando o Token
1. Com o Swagger aberto, clique na rota de login:
2. Depois da rota aberta, clique em *Try it out*:
3. Logo em seguida clique em, *Execute*:
> Obs.: Não será necessário modificar o usuário e senha, este já é o usuário para testes.
4. Role a página para baixo para pegar o token, ele estará no *Response Body*:
> O Token tem validade de 1 hora.
Para consumir as outras rotas basta repetir os passos **1, 2, 3,** nas mesmas, utilizando o token que foi gerado na rota de Login.
### Regras de uma Venda
- Após iniciar uma venda, a mesma só podera ser finalizada se tiver um ou mais items associados a ela e que não estejam cancelados.
- Depois que uma venda é Finalizada não é mais possível cancelar um item da mesma, só será possível cancelar a venda por completo.
- Um item só poderá ser vinculado a venda se o mesmo tiver estoque suficiente.
## Inserção de novos medicamentos via CSV
O sistema permite a inserção de novos medicamentos utilizando um arquivo CSV, utilizando a rota `api/medicines/upload`.
O separador deverá ser **;**(ponto e virgula), com o seguinte cabeçalho:
* name → Nome do Medicamento
* medicine_type_id → Tipo do Medicamento(1: Pilula, 2: Xarope, 3: Gotas)
* dosage → Dosagem do Medicamento
* amount → Preço do Medicamento
* quantity → Quantidade do Medicamento
* provider_id → Identificador do Fornecedor(Em caso de dúvida a rota `/api/providers` devolve uma lista com todos os fornecedores e seus respectivos IDs)
**Observação: Na raiz do projeto há um arquivo, `medicines.csv`, que pode ser utilizado como exemplo**