Singularity Python is a python module and command line tool to provide helpers for working with Singularity containers, specifically providing functions to visualize, package, and compare containers.

• If you are looking for the Singularity Python client to pull, build, and otherwise wrap Singularity functions, then please see the repository singularity-cli for the spython module.
• If you are looking for local management and interaction with various storage locations (e.g., to pull and inspect containers in Singularity Hub, Registry, or other cloud resource) then please see the Global Client for the sregistry module.

You have the option to install only the dependencies that are needed for your functionality of interest.

# All
pip install singularity

# Metrics and analysis dependencies
pip install singularity[metrics]

# Building on Google Cloud
pip install singularity[google[

We currently require Python > version 3 to use various timezone functions. If you are unable to install version 3.0, we provide a Singularity.container for you to use instead. This is the recommended approach as some older versions of Python do not support generation of the timestamp. See the installation docs for your different options.

The Singularity-Python code is licensed under the MIT open source license, which is a highly permissive license that places few limits upon reuse. This ensures that the code will be usable by the greatest number of researchers, in both academia and industry. The following examples are provided:

Please see our complete docs

Please contribute to the package, or post feedback and questions as issues. For points that require discussion of the larger group, please use the Singularity List