#!/usr/bin/env python3
# Timestamp: "2025-10-30 08:47:52 (ywatanabe)"
# File: /home/ywatanabe/proj/scitex-code/src/scitex/template/clone_singularity.py
# ----------------------------------------
from __future__ import annotations
import os
__FILE__ = "./src/scitex/template/clone_singularity.py"
__DIR__ = os.path.dirname(__FILE__)
# ----------------------------------------
"""
Create a new singularity project from the singularity_template.
"""
import sys
from typing import Optional
from ._clone_project import clone_project
TEMPLATE_REPO_URL = "https://github.com/ywatanabe1989/singularity_template.git"
[docs]
def clone_singularity(
project_dir: str,
git_strategy: Optional[str] = "child",
branch: Optional[str] = None,
tag: Optional[str] = None,
**kwargs,
) -> bool:
"""
Create a new singularity project from the template repository.
Parameters
----------
project_dir : str
Path to project directory (will be created). Can be a simple name like "my_project"
or a full path like "./projects/my_project"
git_strategy : str, optional
Git initialization strategy ('child', 'parent', None). Default is 'child'.
branch : str, optional
Specific branch of the template repository to clone. If None, clones the default branch.
Mutually exclusive with tag parameter.
tag : str, optional
Specific tag/release of the template repository to clone. If None, clones the default branch.
Mutually exclusive with branch parameter.
Returns
-------
bool
True if successful, False otherwise
Example
-------
>>> from scitex.template import clone_singularity
>>> clone_singularity("my_singularity_project")
>>> clone_singularity("./projects/my_project")
>>> clone_singularity("my_project", branch="develop")
>>> clone_singularity("my_project", tag="v1.0.0")
"""
return clone_project(
project_dir,
TEMPLATE_REPO_URL,
"singularity_template",
git_strategy,
branch,
tag,
)
def main(args: list = None) -> None:
"""
Command-line interface for clone_singularity.
Parameters
----------
args : list, optional
Command-line arguments. If None, uses sys.argv[1:]
"""
if args is None:
args = sys.argv[1:]
if len(args) < 1:
print("Usage: python -m scitex clone_singularity_project <project-dir>")
print("")
print("Arguments:")
print(" project-dir Path to project directory (will be created)")
print(
" Can be a simple name like 'my_project' or a full path like './projects/my_project'"
)
print("")
print("Example:")
print(" python -m scitex clone_singularity_project my_singularity_project")
print(" python -m scitex clone_singularity_project ./projects/my_project")
sys.exit(1)
project_dir = args[0]
success = clone_singularity(project_dir)
sys.exit(0 if success else 1)
if __name__ == "__main__":
main()
# EOF