add should return the container yaml (#584)

* add should return the container yaml
Signed-off-by: vsoch <[email protected]>

Author: vsoch

CHANGELOG.md

@@ -14,6 +14,7 @@ and **Merged pull requests**. Critical items to know are:
 The versions coincide with releases on pip. Only major versions will be released as tags on Github.
 
 ## [0.0.x](https://github.com/singularityhub/singularity-hpc/tree/main) (0.0.x)
+ - Update add to return container yaml (0.1.11)
  - Fixing bug with writing package file in update (0.1.1)
  - Add support for remote registry and sync commands --all (0.1.0)
   - support for GitLab and GitHub remotes

setup.py

@@ -43,6 +43,7 @@ def get_reqs(lookup=None, key="INSTALL_REQUIRES"):
 VERSION = lookup["__version__"]
 NAME = lookup["NAME"]
 AUTHOR = lookup["AUTHOR"]
+EMAIL = lookup["EMAIL"]
 PACKAGE_URL = lookup["PACKAGE_URL"]
 KEYWORDS = lookup["KEYWORDS"]
 DESCRIPTION = lookup["DESCRIPTION"]
@@ -69,6 +70,7 @@ def get_reqs(lookup=None, key="INSTALL_REQUIRES"):
         name=NAME,
         version=VERSION,
         author=AUTHOR,
+        author_email=EMAIL,
         maintainer=AUTHOR,
         packages=find_packages(),
         include_package_data=True,

shpc/main/container/singularity.py

@@ -46,7 +46,7 @@ def __init__(self):
 
     def exists(self, module_name):
         """
-        A derivate of get to return boolean about container existence.
+        A derivative of get to return boolean about container existence.
         """
         # This can be the module or container directory
         container_dir = self.container_dir(module_name)
@@ -79,7 +79,7 @@ def add(self, module_name, image, config, container_yaml, **kwargs):
         """
         Manually add a registry container, e.g., generating a container.yaml
         for an existing container file. container_yaml is the destination file.
-        If it's already exisitng, it's loaded into config. Otherwise we are
+        If it's already existing, it's loaded into config. Otherwise we are
         using a template config.
         """
         if ":" not in module_name:
@@ -89,7 +89,7 @@ def add(self, module_name, image, config, container_yaml, **kwargs):
 
         # Cut out early if the tag isn't latest, and we already have it
         # DO NOT call config.tags here, it will add an empty latest
-        if tag != "latest" and tag in config._config["tags"]:
+        if tag != "latest" and config._config and tag in config._config["tags"]:
             if not utils.confirm_action(
                 "Tag %s already is defined, are you sure you want to overwrite it? "
                 % tag
@@ -116,6 +116,7 @@ def add(self, module_name, image, config, container_yaml, **kwargs):
             "Registry entry %s was added! Before shpc install, edit:" % module_name
         )
         print(container_yaml)
+        return container_yaml
 
     def _add_local_image(self, name, tag, image, config, container_yaml, **kwargs):
         """
@@ -380,7 +381,7 @@ def _pull_github(self, uri, dest=None):
         repo = "/".join(uri.split("/")[0:2])
         prefix = repo.replace("/", "-")
 
-        # The tag includes release and contianer tag (e.g., 0.0.1:latest)
+        # The tag includes release and container tag (e.g., 0.0.1:latest)
         tag = uri.replace(repo, "", 1).strip("/")
         github_tag, container_tag = tag.split(":", 1)
 

shpc/main/modules/base.py

@@ -200,7 +200,9 @@ def add(self, image, module_name=None, **kwargs):
         config = container.ContainerConfig(
             registry.FilesystemResult(module_name, template), validate=False
         )
-        self.container.add(module_name, image, config, container_yaml=dest, **kwargs)
+        return self.container.add(
+            module_name, image, config, container_yaml=dest, **kwargs
+        )
 
     def get(self, module_name, env_file=False):
         """

shpc/main/registry/__init__.py

@@ -62,7 +62,7 @@ def iter_registry(self, filter_string=None):
 
     def find(self, name, path=None):
         """
-        Find the first occurance of a module.
+        Find the first occurrence of a module.
         """
         # Custom one-off path provided to load from
         if path:

shpc/version.py

@@ -2,8 +2,9 @@
 __copyright__ = "Copyright 2021-2022, Vanessa Sochat"
 __license__ = "MPL 2.0"
 
-__version__ = "0.1.1"
+__version__ = "0.1.11"
 AUTHOR = "Vanessa Sochat"
+EMAIL = "[email protected]"
 NAME = "singularity-hpc"
 PACKAGE_URL = "https://github.com/singularityhub/singularity-hpc"
 KEYWORDS = "singularity, containers, hpc, lmd"