Janus-API

Web app API for janus-core

Installation

Clone the repository from Github and then install the dependencies with uv, after following the instructions recorded here to install uv: https://docs.astral.sh/uv/getting-started/installation/

git clone git@github.com:stfc/janus-api.git
cd janus-api
uv sync

Setup and developing

Once you've installed dependencies, copy config-template.ini, renaming the copy config.ini, and change the variables as required. The default setup will allow you to run the server locally.

Before beginning development make sure to install the pre-commit:

pre-commit install

Usage

Activate the venv and start API with main:

source .venv/bin/activate
python janus_api/main.py