Use plonecli to create Plone addon structure

collective · Apr 22, 2024 · 113c414 · 113c414
1 parent 5be1656
commit 113c414
Show file tree

Hide file tree

Showing 66 changed files with 40 additions and 1,370 deletions.
diff --git a/hooks/post_gen_project.py b/hooks/post_gen_project.py
@@ -264,13 +264,32 @@ def clean_up_backend_tests():
             sys.exit(1)
 
 
-def prepare_backend():
+def prepare_backend(python_package_name):
     """Apply black and isort to the generated codebase."""
     print("Backend codebase")
     # Clean up unused test folders
     clean_up_backend_tests()
     steps = [
-        ["Format generated code in the backend", ["make", "format"], False, "backend"]
+        [
+            "Create python package using plonecli",
+            [
+                "pipx run plonecli create --bobconfig=src/.mrbob.ini addon "
+                f" src/{python_package_name}"
+            ],
+            True,
+            "backend",
+        ],
+        [
+            "Use the plone_site_initialization template in plonecli to create"
+            " some defaults",
+            [
+                "pipx run plonecli add --bobconfig=../.mrbob.ini"
+                " site_initialization",
+            ],
+            True,
+            f"backend/src/{python_package_name}",
+        ],
+        ["Format generated code in the backend", ["make", "format"], False, "backend"],
     ]
     for step in steps:
         msg, command, shell, cwd = step
@@ -283,7 +302,7 @@ def prepare_backend():
 volto_generator_version = "{{ cookiecutter.volto_generator_version }}"
 volto_addon_name = "{{ cookiecutter.volto_addon_name }}"
 description = "{{ cookiecutter.description }}"
-
+python_package_name = "{{ cookiecutter.python_package_name }}"
 
 def main():
     """Final fixes."""
@@ -298,7 +317,7 @@ def main():
     )
     print("")
     # Setup backend
-    prepare_backend()
+    prepare_backend(python_package_name=python_package_name)
     print("")
     print(f"{MSG_DELIMITER}")
     msg = dedent(

diff --git a/...n_package_name }}/browser/static/.gitkeep → ...tter.project_slug }}/backend/src/.gitkeep b/...n_package_name }}/browser/static/.gitkeep → ...tter.project_slug }}/backend/src/.gitkeep
diff --git a/{{ cookiecutter.project_slug }}/backend/src/.mrbob.ini b/{{ cookiecutter.project_slug }}/backend/src/.mrbob.ini
@@ -0,0 +1,17 @@
+[mr.bob]
+verbose = True
+
+[variables]
+author.name = {{ cookiecutter.author }}
+author.email = {{ cookiecutter.email }}
+author.github.user = {{ cookiecutter.github_organization }}
+package.description = {{ cookiecutter.description }}
+package.git.init = n
+package.git.disabled = y
+
+plone.version = {{ cookiecutter.plone_version }}
+python.version = 3.10
+vscode_support = n
+
+language = {{ cookiecutter.language_code }}
+site_name = {{ cookiecutter.project_title }}
diff --git a/...r.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/CHANGES.md b/...r.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/CHANGES.md
diff --git a/...ject_slug }}/backend/src/{{ cookiecutter.python_package_name }}/CONTRIBUTORS.md b/...ject_slug }}/backend/src/{{ cookiecutter.python_package_name }}/CONTRIBUTORS.md
diff --git a/...okiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/LICENSE.GPL b/...okiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/LICENSE.GPL
diff --git a/...r.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/LICENSE.md b/...r.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/LICENSE.md
diff --git a/...okiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/MANIFEST.in b/...okiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/MANIFEST.in
diff --git a/...er.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/README.md b/...er.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/README.md
diff --git a/{{ cookiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/setup.py b/{{ cookiecutter.project_slug }}/backend/src/{{ cookiecutter.python_package_name }}/setup.py
diff --git a/...ookiecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/__init__.py b/...ookiecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/__init__.py
diff --git a/...r.python_package_name }}/src/{{ cookiecutter.python_package_name }}/behaviors/__init__.py b/...r.python_package_name }}/src/{{ cookiecutter.python_package_name }}/behaviors/__init__.py
diff --git a/...ython_package_name }}/src/{{ cookiecutter.python_package_name }}/behaviors/configure.zcml b/...ython_package_name }}/src/{{ cookiecutter.python_package_name }}/behaviors/configure.zcml
diff --git a/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/browser/__init__.py b/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/browser/__init__.py
diff --git a/....python_package_name }}/src/{{ cookiecutter.python_package_name }}/browser/configure.zcml b/....python_package_name }}/src/{{ cookiecutter.python_package_name }}/browser/configure.zcml
diff --git a/...iecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/configure.zcml b/...iecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/configure.zcml
diff --git a/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/content/__init__.py b/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/content/__init__.py
diff --git a/...utter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/dependencies.zcml b/...utter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/dependencies.zcml
diff --git a/...er.python_package_name }}/src/{{ cookiecutter.python_package_name }}/indexers/__init__.py b/...er.python_package_name }}/src/{{ cookiecutter.python_package_name }}/indexers/__init__.py
diff --git a/...python_package_name }}/src/{{ cookiecutter.python_package_name }}/indexers/configure.zcml b/...python_package_name }}/src/{{ cookiecutter.python_package_name }}/indexers/configure.zcml
diff --git a/...kiecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/interfaces.py b/...kiecutter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/interfaces.py
diff --git a/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/locales/__init__.py b/...ter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/locales/__init__.py
diff --git a/...utter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/locales/update.py b/...utter.python_package_name }}/src/{{ cookiecutter.python_package_name }}/locales/update.py