History

Will Webberley 64b124b37e Add ruff python checks/formats		2024-10-04 19:54:24 +01:00
..
api	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
util	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
.gitignore	initial commit	2021-11-13 18:10:35 +00:00
app.py	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
Dockerfile	de-chaliced API	2024-10-04 19:45:54 +01:00
envfile	Added sign-up notifier	2023-12-23 06:14:30 +00:00
lint.sh	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
poetry.lock	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
pyproject.toml	Add ruff python checks/formats	2024-10-04 19:54:24 +01:00
README.md	bumped Python version	2024-10-04 19:50:07 +01:00

SSO Tools Web API

This directory contains the source code for the primary API for the SSO Tools webapp. This service provides the endpoints required for managing IdPs.

Preparing a local environment

Firstly, create and enter a virtual environment:

virtualenv -p python3.12 .venv # You only need this the first time
source .venv/bin/activate

Install dependencies (you may need to install Poetry first):

poetry install

Firstly, source the environment file:

source envfile

Then you can run the service:

flask run

Note: The service expects to be able to connect to a local MongoDB running on port 27017.

Once running, the service is available on port 6002.