Welcome to the Singularity Python documentation!

Singularity Python is a Python API to work with the Singularity open source software. Are you a scientist or developer? You likely will be most interested in the ability to interact with Singularity containers from your own Python scripts. See here for the core module docstrings.

• Installation: to your system with the python package manager pip, or use the client in a container that we provide.
• Recipes: Interact with and convert Dockerfile and Singularity Recipes
• Commands: Learn how to interact with Singularity using functions from the spython module.
• Developers: The readthedocs documentation for the Singularity Python API.

This is an open source project. Please contribute to the package, or post feedback and questions as issues. You'll notice a little eliipsis () next to each header section. If you click this, you can open an issue relevant to the section, grab a permalink, or suggest a change. You can also talk to us directly on Gitter.

We welcome any kind of contribution, whether a suggestion, a bug fix, feature request, or new feature. See our contributing docs for more information.

This code is licensed under the MPL 2.0 LICENSE.