nf_core.licences

Lists software licences for a given workflow.

classnf_core.licences.WorkflowLicences(pipeline)

Bases: object

A nf-core workflow licenses collection.

Tries to retrieve the license information from all dependencies of a given nf-core pipeline.

A condensed overview with license per dependency can be printed out.

• Parameters: pipeline (str) – An existing nf-core pipeline name, like nf-core/hlatyping or short hlatyping.

clean_licence_names(licences)

Normalises varying licence names.

• Parameters: licences (list) – A list of licences which are basically raw string objects from the licence content information.
• Returns: Cleaned licences.
• Return type: list

fetch_conda_licences()

Fetch package licences from Anaconda and PyPi.

get_environment_file()

Get the conda environment file for the pipeline

print_licences()

Prints the fetched license information.

• Parameters: as_json (boolean) – Prints the information in JSON. Defaults to False.

run_licences()

Run the nf-core licences action