Merge pull request #243 from bobleesj/entry-pt-create-update

feat: allow running commands with `package create` and `package update` with an entry point of `package` to `app.py`

news/entry-pt-create-update.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* Add `package create` and `package update` commands once `scikit-package` is installed.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

pyproject.toml

@@ -51,6 +51,9 @@ namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements/pip.txt"]}
 
+[project.scripts]
+package = "scikit_package.app:main"
+
 [tool.codespell]
 exclude-file = ".codespell/ignore_lines.txt"
 ignore-words = ".codespell/ignore_words.txt"

requirements/conda.txt

@@ -0,0 +1 @@
+cookiecutter

requirements/pip.txt

@@ -0,0 +1 @@
+cookiecutter

src/scikit_package/app.py

@@ -0,0 +1,58 @@
+import subprocess
+from argparse import ArgumentParser
+
+
+def create():
+    run_cookiecutter()
+
+
+def update():
+    # FIXME: Implement the update command.
+    # As of now it does the same as the create command.
+    run_cookiecutter()
+
+
+def run_cookiecutter():
+    try:
+        subprocess.run(
+            [
+                "cookiecutter",
+                "https://github.com/Billingegroup/scikit-package",
+            ],
+            check=True,
+        )
+    except subprocess.CalledProcessError as e:
+        print(f"Failed to run scikit-package for the following reason: {e}")
+
+
+def setup_subparsers(parser):
+    # Create "create" subparser
+    parser_create = parser.add_parser("create", help="Create a new package")
+    parser_create.set_defaults(func=create)
+    # Create "update" subparser
+    parser_update = parser.add_parser(
+        "update", help="Update an existing package"
+    )
+    parser_update.set_defaults(func=update)
+
+
+def main():
+    """Entry point for the scikit-package CLI.
+
+    Examples
+    --------
+    >>> package create
+    >>> package update
+    """
+
+    parser = ArgumentParser(
+        description="Manage package operations with scikit-package."
+    )
+    subparsers = parser.add_subparsers(dest="command", required=True)
+    setup_subparsers(subparsers)
+    args = parser.parse_args()
+    args.func()
+
+
+if __name__ == "__main__":
+    main()

{{ cookiecutter.github_repo_name }}/AUTHORS.rst

@@ -1,7 +1,7 @@
 Authors
 =======
 
-Billinge Group and community contributors.
+{{ cookiecutter.contributors }}
 
 Contributors
 ------------