https://github.com/wesgtox/prescriptions-api
Medical prescription service.
https://github.com/wesgtox/prescriptions-api
aiohttp docker docker-compose fastapi poetry-python postgresql pytest pytest-cov python python-asynchronous redis redis-cache redis-server sqlalchemy
Last synced: 12 months ago
JSON representation
Medical prescription service.
- Host: GitHub
- URL: https://github.com/wesgtox/prescriptions-api
- Owner: WesGtoX
- License: mit
- Created: 2022-01-20T04:05:11.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-26T06:39:21.000Z (about 4 years ago)
- Last Synced: 2025-01-13T06:09:40.761Z (about 1 year ago)
- Topics: aiohttp, docker, docker-compose, fastapi, poetry-python, postgresql, pytest, pytest-cov, python, python-asynchronous, redis, redis-cache, redis-server, sqlalchemy
- Language: Python
- Homepage:
- Size: 175 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Prescriptions API
About |
Technology |
Getting Started |
Usage |
Roadmap |
License
## About the Project
Prescription API is a medical prescription service, which inserts new prescriptions and integrates with another service that has four endpoints:
- `[GET] /physicians/:id/`: returns the data of a specific physician by its `ID`.
- `[GET] /clinics/:id/`: returns the data of a specific clinic by its `ID`.
- `[GET] /patients/:id/`: returns the data of a specific patient by their `ID`.
- `[POST] /metrics/`: final data integration, where the fetched data will be saved.
## Technology
This project was developed with the following technologies:
- [Python](https://www.python.org/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [PostgreSQL](https://www.postgresql.org/)
- [Redis](https://redis.io/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
## Getting Started
### Prerequisites
- [Python](https://www.python.org/downloads/)
- [Docker](https://docs.docker.com/get-started/)
- [Docker Compose](https://docs.docker.com/compose/install/)
### Install and Run
1. Clone the repository:
```bash
git clone https://github.com/WesGtoX/prescriptions-api.git
```
2. Set the environment variables:
```bash
cp .env.sample .env
```
3. Run:
```bash
make run
```
4. Run tests:
```bash
make test
```
## Usage
- [Prescription Live API](https://prescriptions-api-wes.herokuapp.com/)
- [Prescriptions Docs](https://prescriptions-api-wes.herokuapp.com/docs)
- [Prescriptions Redoc](https://prescriptions-api-wes.herokuapp.com/redoc)
- [ScanAPI Report](https://python-challenge-scanapi.dev.iclinic.com.br/result?o=1643176921)
## Roadmap
See the [open issues](https://github.com/WesGtoX/prescriptions-api/issues) for a list of proposed features (and known issues).
## License
Distributed under the MIT License. See [LICENSE](LICENSE) for more information.
---
Made with ♥ by [Wesley Mendes](https://wesleymendes.com.br/) :wave: