The Open Brewery DB API server is a FastAPI REST-based API server connected to a PostgreSQL DB server.
- Python 3.10.6
- Create a virtual environment
python3 -m venv venv
- Activate environment
source ./venv/bin/activate
- Install dependencies
pip3 install -r requirements.txt
- Run the tests
pytest
- Run the server
uvicorn main:app- Change the host to any connection
--host=0.0.0.0
- Change the port (8001 used as example)
--port=8001
https://localhost:8000/(HTML)https://localhost:8000/v1/healthcheck(JSON)
| Task | Complete? |
|---|---|
| Setup repo | ✅ |
| README | ✅ |
| Initial Unit/Request tests | ✅ |
| Endpoint placeholders | |
| Pydantic models | |
| Update tests | |
| DB Mocks | |
| Query validation | |
| Path validation | |
| Sentry integration | |
| Authentication | |
| Rate-limiting |
For information on contributing to this project, please see the contributing guide and our code of conduct.
Any feedback, please email me.
Cheers! 🍻