Skip to content
This repository has been archived by the owner on Feb 19, 2023. It is now read-only.

Latest commit

 

History

History
68 lines (42 loc) · 2.64 KB

README.md

File metadata and controls

68 lines (42 loc) · 2.64 KB
Raw

Microauth

A fast, documented, and tested python3 API boilerplate application

Tired of reinventing the wheel every time you need user authentication in a project?

Fill out a simple config file and have RESTful API endpoints for everything needed for account management.

Screenshot

Features:

  • Full API documentation via Swagger at /docs
  • Account confirmation and password resets via email, powered by Sendgrid
  • Production Docker setup
  • Thorough unit test coverage
  • json logging

Running locally (first time)

uses Python3.6+, Docker, and Docker-compose

  1. Create a virtual environment for dependencies with python3 -m venv .venv/. Activate it with source .venv/bin/activate.
  2. Dependencies are managed with Poetry. Install dependencies with poetry install.
  3. Run pre-commit install to configure git commit hooks (for flake8 checking and black formatting).
  4. Copy default.env to a new file .env.
  5. Run docker-compose up -d database to run a local PostgreSQL instance for testing and development.
  6. Initialize the database with python3 app/utils/init_db.py.
  7. Run the application with python3 app/main.py.

View documentation at http://localhost:8000/docs

Production

  1. Create a PostgreSQL instance on the cloud provider of your choice (AWS, Digital Ocean, etc).
  2. Fill out .env with your credentials, and change API_ENV to PRODUCTION.
  3. Initialize the database with python3 app/utils/init_db.py
  4. Build the project with docker build -t microauth .
  5. Run with docker run -p 8000:8000 -d microauth

Tests

Run test suite with pytest --cov=app tests/.

Email Resets (Optional)

If you would like users to be able to verify their email address and reset their passwords, sign up for a Sendgrid Account and add your API Key to .env.

Credit for the email HTML templates

Adding new models

  1. Create sqlalchemy model in app/models/.
  2. Create database queries for the model in app/db/
  3. Create Pydantic "Schema" in app/schemas/ for API validation and documentation
  4. Import model in alembic/env.py and utils/init_db.py

Now you should be ready to apply a change to your existing database with alembic. alembic revision -m "made some change" --autogenerate (generates migration plan in alembic/versions/) alembic upgrade head (applies database changes)

Testing

Tests are always run against the local docker PostgreSQL instance. The database is re-initialized before each test, and after the last test is run.