clink 0.32.1

Component Link.

Component Link

Documentation: https://askapsdp.gitlab.io/clink/

Development environment

Docker (compose) is used both for development and for GitLab CI to ensure a consistent environment.

Get started by cloning the repository and work on the develop branch:

git clone --branch=develop ssh://[e-mail]:7999/askapsdp/clink.git

Copy the env.template file to .env for local customisation:

cp env.template .env

Build services

docker, docker-compose, and fabric (v2+) should be installed and available locally to build/run the containers. On Ubuntu 20.04, you can install these with:

sudo apt install docker docker-compose fabric

To build the docker containers:

fab build

Develop and test

Remember to run the tests locally when developing to catch failures before CI is run on push to the repo.

Run tests:

fab tox

Other commands

Generate docs:

fab docs

Python shell:

fab shell