README.md

Auth Service

Auth Service is a REST API that provides authentication and authorization for the Schedutn project.

Continuous Integration

This project uses make as an adaptation layer.

Run make help to see all available commands.

Development Environment

Installing Poetry

This package uses poetry for dependency management.

Install poetry in the system site_packages. DO NOT INSTALL IT in a virtual environment itself.

To install poetry, run:

pip install poetry

Building the Development Environment

1. Clone the repository

git clone "[email protected]:tomasanchez/grupo-3-tacs.git"

2. Install the dependencies.

If you don't start in a virtual environment poetry will create one for you.

cd grupo-3-tacs/auth && poetry install

Note that poetry doesn't activate the virtual environment for you. You have to do it manually. Or prefix subsequent the commands with poetry run.

You can view the environment that poetry uses with poetry env info.

To activate run:

poetry shell

Running Local

1. Run:

poetry run python -m auth.main

2. Go to http://127.0.0.0:8000/docs to see the API documentation.

Running Tests

Run:

poetry run pytest

To generate a coverage report add --cov src.

poetry run pytest --cov src

Updating Dependencies

To update the dependencies run:

poetry update

Recommended Readings

• FastAPI
• Pydantic
• Cosmic Python