clink 0.30.0

Component Link.

# Component Link

[](https://gitlab.com/ASKAPSDP/clink/commits/develop) [](https://askapsdp.gitlab.io/clink/coverage/)

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:

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

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

`bash 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:

`bash sudo apt install docker docker-compose fabric `

To build the docker containers:

`bash 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:

`bash fab tox `

### Other commands

Generate docs:

`bash fab docs `

Python shell:

`bash fab shell `