twkit
is a Python wrapper for the Nextflow Tower CLI. It can be leveraged to automate the creation of all of the entities in Nextflow Tower via a simple configuration file in YAML format.
The key features are:
- Simple configuration: All of the command-line options available when using the Nextflow Tower CLI can be defined in simple YAML format.
- Infrastructure as Code: Enable users to manage and provision their infrastructure specifications.
- Automation: End-to-end creation of entities within Nextflow Tower, all the way from adding an Organization to launching pipeline(s) within that Organization.
You will need to have an account on Nextflow Tower (see Plans and pricing).
twkit
requires the following dependencies:
Alternatively, you can install the dependencies via Conda by downloading and using the Conda environment file that has been supplied in this repository:
conda env create -f environment.yml
conda activate twkit
The scripts in this repository are packaged and available on PyPI. They can be installed via pip
:
pip install twkit
You can force overwrite the installation to use the latest changes with the command below:
pip install --upgrade --force-reinstall twkit
Create a Tower access token using the Nextflow Tower web interface via the Your Tokens page in your profile.
twkit
reads this token from the environment variable TOWER_ACCESS_TOKEN
. Please export it into your terminal as shown below:
export TOWER_ACCESS_TOKEN=<your access token>
You must provide a YAML file that defines the options for each of the entities you would like to create in Nextflow Tower.
You will need to have an account on Nextflow Tower (see Plans and pricing). You will also need access to a Workspace and a pre-defined Compute Environment where you can launch a pipeline.
-
Create a YAML file called
hello-world-config.yml
with the contents below, and customise the<YOUR_WORKSPACE>
and<YOUR_COMPUTE_ENVIRONMENT>
entries as required:launch: - name: 'hello-world' # Workflow name workspace: '<YOUR_WORKSPACE>' # Workspace name compute-env: '<YOUR_COMPUTE_ENVIRONMENT>' # Compute environment revision: 'master' # Pipeline revision pipeline: 'https://github.com/nextflow-io/hello' # Pipeline URL
-
Launch the pipeline with
twkit
:twkit hello-world-config.yml
-
Login to your Tower instance and check the Runs page in the appropriate Workspace for the pipeline you just launched!
You can also launch the same pipeline via a Python script. This will essentially allow you to extend the functionality on offer within the Tower CLI by leveraging the flexibility and customisation options available in Python.
-
Download the
launch_hello_world.py
Python script and customise the<YOUR_WORKSPACE>
and<YOUR_COMPUTE_ENVIRONMENT>
entries as required. -
Launch the pipeline with
twkit
:python launch_hello_world.py
-
Login to your Tower instance and check the Runs page in the appropriate Workspace for the pipeline you just launched!
Please see twkit-e2e.yml
for an end-to-end example that highlights how you can use twkit
to create everything sequentially in Nextflow Tower all the way from creating a new Organization to launching a pipeline.
We have provided template YAML files for each of the entities that can be created on Tower. These can be found in the templates/
directory and should form a good starting point for you to add your own customization:
- organizations.yml
- teams.yml
- workspaces.yml
- participants.yml
- credentials.yml
- secrets.yml
- compute-envs.yml
- actions.yml
- datasets.yml
- pipelines.yml
- launch.yml
If you would like to contribute to twkit
, please see the contributing guidelines.
For further information or help, please don't hesitate to create an issue in this repository.
twkit
was written by Esha Joshi, Adam Talbot and Harshil Patel from the Scientific Development Team at Seqera Labs.