♻️ Remove/replace AiiDA-related content

mbercx · mbercx · commit 35d358080799 · 2025-08-11T09:03:56.000+10:00
This repository was mirrored from a template for AiiDA plugin packages: https://github.com/mbercx/aiida-plugin-copier But we considered it useful to have a more generic Python package version of the template. Here we remove/replace all AiiDA-related references and content, to convert the template into a generic Python package one.
diff --git a/README.md b/README.md
@@ -1,16 +1,16 @@
 [![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier)
 
-# `aiida-plugin-copier`
+# `python-copier`
 
-Template for AiiDA plugin packages based on [`copier`](https://copier.readthedocs.io/en/latest/).
+Template for Python packages based on [`copier`](https://copier.readthedocs.io/en/latest/).
 
 ## Usage
 
 Follow the [`copier` installation instructions](https://copier.readthedocs.io/en/latest/#installation).
 Then simply run
 
 ```
-copier copy https://github.com/mbercx/aiida-plugin-copier <plugin_name>
+copier copy https://github.com/mbercx/python-copier <package_name>
 ```
 
-And answer the questions to generate a new AiiDA plugin package.
+And answer the questions to generate a new Python package.
diff --git a/copier.yml b/copier.yml
@@ -1,12 +1,12 @@
-plugin_name:
+package_name:
   type: str
-  help: 'What is the name of your plugin package?'
+  help: 'What is the name of your Python package?'
   default: '{{_folder_name }}'
 description:
   type: str
-  help: 'Describe what your plugin package is for.'
-  default: 'AiiDA plugin package'
+  help: 'Describe what your Python package is for.'
+  default: 'Python package'
 
 _subdirectory: template
 _message_after_copy: |
-  The `{{plugin_name}}` package has been created successfully!
+  The `{{package_name}}` package has been created successfully!
diff --git a/docs/design.md b/docs/design.md
@@ -35,7 +35,7 @@ This pattern has a few advantages:
 
 ## Documentation
 
-We use [MyST Markdown](https://mystmd.org/) for our AiiDA plugin package documentation.
+We use [MyST Markdown](https://mystmd.org/) for our Python package documentation.
 We want to use a Markdown-based documentation tool for simplicity, avoiding Sphinx' reStructuredText format.
 The main reason to use this over [MkDocs](https://www.mkdocs.org/) to test the Jupyter notebook integration, especially the "executable content".
 MyST is also easy to integrate with Sphinx, which has a lot of powerful tools, especially for scientific software.
diff --git a/docs/developer.md b/docs/developer.md
@@ -2,7 +2,7 @@
 
 !!! Info
 
-    Just to clarify: this guide is for developers of the `copier` template, not AiiDA plugin package developers.
+    Just to clarify: this guide is for developers of the `copier` template, not Python package developers.
 
 This template package uses several [Hatch environments](https://hatch.pypa.io/latest/environment/) to execute developer tasks or "scripts".
 To see the environments and their corresponding scripts, run:
@@ -21,7 +21,7 @@ The default Hatch environment defines a set of scripts related to the template,
 
     hatch run copy <target_directory>
 
-Will copy the fully rendered template as the `aiida-test` package in the `<target_directory>`.
+Will copy the fully rendered template as the `py-package` package in the `<target_directory>`.
 Other scripts for the default environment:
 
 * `check`: Copy/Update the template in the `.tmp` directory and check the rendered files by linting them with `hatch fmt -l`.
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,14 @@
 # Getting Started
 
-A `copier`-based template for AiiDA plugin packages.
+A `copier`-based template for Python packages.
 
 ## Usage
 
 Follow the [`copier` installation instructions](https://copier.readthedocs.io/en/latest/#installation).
 Then simply run
 
 ```
-copier copy https://github.com/mbercx/aiida-plugin-copier <plugin_name>
+copier copy https://github.com/mbercx/python-copier <package_name>
 ```
 
-And answer the questions to generate a new AiiDA plugin package.
+And answer the questions to generate a new Python package.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: AiiDA-plugin-copier
+site_name: Python copier
 theme:
   name: material
 markdown_extensions:
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,22 +1,23 @@
 [tool.hatch.envs.default]
 dependencies = [
   "copier",
-  "uv"
+  "uv",
+  "mystmd"
 ]
 scripts.copy = [
-  "copier copy --vcs-ref=HEAD . {args:.tmp/aiida-test} -f",
+  "copier copy --vcs-ref=HEAD . {args:.tmp/py-package} -f",
 ]
 scripts.install = [
-  "copier copy --vcs-ref=HEAD . .tmp/aiida-test -f",
-  "uv pip install .tmp/aiida-test",
+  "copier copy --vcs-ref=HEAD . .tmp/py-package -f",
+  "uv pip install .tmp/py-package",
 ]
 scripts.check = [
-  "copier copy --vcs-ref=HEAD . .tmp/aiida-test -f",
-  "hatch fmt -l --check .tmp/aiida-test",
+  "copier copy --vcs-ref=HEAD . .tmp/py-package -f",
+  "hatch fmt -l --check .tmp/py-package",
 ]
 scripts.docs = [
-  "copier copy --vcs-ref=HEAD . .tmp/aiida-test -f",
-  "cd .tmp/aiida-test/docs && myst start",
+  "copier copy --vcs-ref=HEAD . .tmp/py-package -f",
+  "cd .tmp/py-package/docs && myst start",
 ]
 scripts.clean = [
   "ruff clean",
diff --git a/template/README.md.jinja b/template/README.md.jinja
@@ -1,3 +1,3 @@
-# `{{plugin_name}}`
+# `{{package_name}}`
 
 {{description}}
diff --git a/template/docs/img/aiida-icon.ico b/template/docs/img/aiida-icon.ico
diff --git a/template/docs/img/aiida-logo.svg b/template/docs/img/aiida-logo.svg
diff --git a/template/docs/index.md.jinja b/template/docs/index.md.jinja
@@ -1,5 +1,5 @@
 # Introduction
 
-This is the documentation of the `{{ plugin_name }}` plugin package for AiiDA.
+This is the documentation of the `{{ package_name }}` Python package.
 
 {{ description }}
diff --git a/template/docs/myst.yml.jinja b/template/docs/myst.yml.jinja
@@ -2,14 +2,11 @@
 version: 1
 project:
   id: a557e2e8-77c6-4b93-96eb-a33e837935d4
-  title: {{ plugin_name }}
+  title: {{ package_name }}
   description: {{ description }}
   # keywords: []
   # authors: []
   # github: https://github.com/
   # To autogenerate a Table of Contents, run "myst init --write-toc"
 site:
   template: book-theme
-  options:
-    favicon: img/aiida-icon.ico
-    logo: img/aiida-logo.svg
diff --git a/template/pyproject.toml.jinja b/template/pyproject.toml.jinja
@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "{{plugin_name}}"
+name = "{{package_name}}"
 dynamic = ["version"]
 description = ''
 readme = "README.md"
@@ -22,7 +22,7 @@ classifiers = [
 ]
 
 [tool.hatch.version]
-path = "src/{{ plugin_name.lower().replace('-', '_') }}/__about__.py"
+path = "src/{{ package_name.lower().replace('-', '_') }}/__about__.py"
 
 
 [tool.hatch.envs.docs]
diff --git a/template/src/{{ package_name.lower().replace('-', '_') }}/__about__.py b/template/src/{{ package_name.lower().replace('-', '_') }}/__about__.py
diff --git a/template/src/{{ package_name.lower().replace('-', '_') }}/__init__.py.jinja b/template/src/{{ package_name.lower().replace('-', '_') }}/__init__.py.jinja

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-site_name: AiiDA-plugin-copier`
	`1`	`+site_name: Python copier`
`2`	`2`	`theme:`
`3`	`3`	`name: material`
`4`	`4`	`markdown_extensions:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-# `{{plugin_name}}`
	`1`	+# `{{package_name}}`
`2`	`2`
`3`	`3`	`{{description}}`