doc/commands

spcd/__init__.py

@@ -44,8 +44,12 @@ def clone_project_branch() -> None:
         )
 
 
-def install_commands(path: str) -> None:
+def install_commands(path: Path) -> None:
-    """Make commands callable in the operating system."""
+    """Make commands callable in the operating system.
+
+    :param path: entry point that commands will call
+    :type path: Path
+    """
     step("Install commands")
     user = Path("/usr/local/bin")
     for command in [
@@ -92,8 +96,12 @@ def list_environment_variables() -> None:
             log.info("%s", variable)
 
 
-def main(main_file: str) -> None:
+def main(main_file: Path) -> None:
-    """Entry point to initialize environment or run a specific command."""
+    """Entry point to initialize environment or run a specific command.
+
+    :param main_file: entry point file calling this function
+    :type main_file: Path
+    """
     paths = environ["PATH"].split(pathsep)
     if env.SPCD_PYTHON_VENV_BINARIES not in paths:
         environ["PATH"] = pathsep.join([env.SPCD_PYTHON_VENV_BINARIES, *paths])

spcd/__main__.py

@@ -4,6 +4,7 @@
 
 import importlib
 import sys
+from pathlib import Path
 
 if __name__ == "__main__":
     env = importlib.import_module("env")
@@ -11,4 +12,4 @@ if __name__ == "__main__":
         sys.path.insert(0, env.SPCD_PYTHON_VENV_PACKAGES)
     from spcd import main
 
-    main(__file__)
+    main(Path(__file__))

spcd/cmd.py

@@ -32,7 +32,13 @@ def spcd_check_project() -> None:
 def spcd_synchronize(
     target: str | None = None, source: str | None = None
 ) -> None:
-    """Synchronize output towards a target."""
+    """Synchronize output towards a target.
+
+    :param target: where to deploy to
+    :type target: str | None
+    :param source: where to deploy from
+    :type source: str | None
+    """
     if not target:
         user = "cd"
         host = env.SPCD_PROJECT_PATH

spcd/project.py

@@ -28,7 +28,11 @@ class Project:
     """Current project."""
 
     def __init__(self, projects: Projects) -> None:
-        """Set projects, branch, name, root & url."""
+        """Set projects, branch, name, root & url.
+
+        :param projects: parent class with environment
+        :type projects: Projects
+        """
         self.projects = projects
         # branch
         for variable in BRANCH: