Setup Guide

This document complements the guidelines set out in the SKA telescope developer portal

Tooling Pre-requisites

Below are some tools that will be required to work with the data product API:

• Python 3.10 or later versions: Install page URL: https://www.python.org/downloads/

• Poetry 1.6 or later versions: Install page URL: https://python-poetry.org/docs/#installation

• GNU make 4.2 or later versions: Install page URL: https://www.gnu.org/software/make/

Development setup

Clone the repository and its submodules:

git clone --recursive git@gitlab.com:ska-telescope/ska-permissions-api.git

Running the application

Configure the environmental variables in the .env file under the root folder according to your requirements and environment. The default values are:

none

To run the application directly on your host machine:

cd ska-permissions-api
poetry shell
poetry install
make run-dev

The API will then be accessible at http://127.0.0.1:8000