Skip to content

openbrewerydb/openbrewerydb-fastapi

Repository files navigation

🍻 Official Open Brewery DB FastAPI REST API Server

Open Brewery DB Logo

🛑 NOTE: WORK IN PROGRESS

The Open Brewery DB API server is a FastAPI REST-based API server connected to a PostgreSQL DB server.

Documentation

📦 Dependencies

  • Python 3.10.6

🚀 Getting Started

  • 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

Endpoints

  • https://localhost:8000/ (HTML)
  • https://localhost:8000/v1/healthcheck (JSON)

🚛 Roadmap

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

🤝 Contributing

For information on contributing to this project, please see the contributing guide and our code of conduct.

🔗 Related

👾 Community

📫 Feedback

Any feedback, please email me.

Cheers! 🍻