https://github.com/labatata101/oximeter-rest-api
REST Api for manipulating the sensor data received from the oximeter monitor.
https://github.com/labatata101/oximeter-rest-api
fastapi python rest-api
Last synced: about 1 month ago
JSON representation
REST Api for manipulating the sensor data received from the oximeter monitor.
- Host: GitHub
- URL: https://github.com/labatata101/oximeter-rest-api
- Owner: LaBatata101
- License: gpl-3.0
- Created: 2022-08-20T21:48:27.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-21T21:05:50.000Z (almost 4 years ago)
- Last Synced: 2025-03-13T22:27:25.869Z (over 1 year ago)
- Topics: fastapi, python, rest-api
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Oximeter REST Api
Project made for my Microcontrollers class, the goal of this project is to collect the heartrate and oxygen saturation data using the ESP32 microcontroller
and the MAX30100 sensor. The whole project is divided into 3 parts/repositories: the [microcontroller firmware](https://github.com/LaBatata101/oximeter-esp32-firmware),
the REST Api (this repository) for the data management and the [Telegram bot](https://github.com/LaBatata101/oximeter-telegram-bot) for real time data visualization.
The API offers 5 routes to manipulate the data received from the sensor, you can check them by going to [http://127.0.0.1:8000/docs#/](http://127.0.0.1:8000/docs#/)
after running the project.
## Dependencies
- fastapi v0.78.0
- SQLAlchemy v1.4.39
- uvicorn v0.18.2
- alembic v1.8.0
- psycopg2-binary v2.9.3
- PostgreSQL v14.3
## Installing and running the project
Clone the project:
```bash
$ git clone https://github.com/LaBatata101/oximeter-rest-api
$ cd oximeter-rest-api/
```
Installing the dependencies using `pip`:
```bash
$ pip install -r requirements.txt
```
Or, using `poetry`:
```bash
$ poetry install
```
Running:
```bash
$ POSTGRES_USER=YOUR_DB_USER POSTGRES_PASSWORD=YOUR_DB_PASSWORD POSTGRES_SERVER=YOUR_DB_SERVER POSTGRES_DB=YOUR_DB_NAME uvicorn oximeter.main:app --reload
```