refactor(ongoing): introduce cookiecutter

x-pt · Aug 13, 2024 · 8833bb6 · 8833bb6
1 parent f745668
commit 8833bb6
Show file tree

Hide file tree

Showing 39 changed files with 80 additions and 92 deletions.
diff --git a/cookiecutter.json b/cookiecutter.json
@@ -0,0 +1,19 @@
+{
+    "templates": {
+        "cxx": {
+            "path": "./template/cxx",
+            "title": "C++ Project",
+            "description": "A cookiecutter template for a cxx project"
+        },
+        "go": {
+            "path": "./template/go",
+            "title": "Go Project",
+            "description": "A cookiecutter template for a go project"
+        },
+        "python": {
+            "path": "./template/py",
+            "title": "Python Project",
+            "description": "A cookiecutter template for a python project"
+        }
+    }
+}
diff --git a/template/cxx/.github/PULL_REQUEST_TEMPLATE.md b/template/cxx/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@
 <!--
 Please make sure:
 - you have read the contributing guidelines:
-  https://github.com/{{gh_uname}}/{{project-name}}/blob/main/docs/CONTRIBUTING.md
+  https://github.com/{{gh_uname}}/{{cookiecutter.package_name}}/blob/main/docs/CONTRIBUTING.md
 - you have updated the changelog (if needed):
-  https://github.com/{{gh_uname}}/{{project-name}}/blob/main/CHANGELOG.md
+  https://github.com/{{gh_uname}}/{{cookiecutter.package_name}}/blob/main/CHANGELOG.md
 -->
diff --git a/template/cxx/compose.yml b/template/cxx/compose.yml
@@ -1,12 +1,12 @@
 version: Compose specification
 
 service:
-    {{project-name}}:
+    {{cookiecutter.package_name}}:
         build: .
 
 networks:
-    {{project-name}}-net:
-        name: {{project-name}}-net
+    {{cookiecutter.package_name}}-net:
+        name: {{cookiecutter.package_name}}-net
         ipam:
             config:
                 -   subnet: 172.16.238.0/24
diff --git a/template/go/.github/PULL_REQUEST_TEMPLATE.md b/template/go/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@
 <!--
 Please make sure:
 - you have read the contributing guidelines:
-  https://github.com/{{gh_uname}}/{{project-name}}/blob/main/docs/CONTRIBUTING.md
+  https://github.com/{{gh_uname}}/{{cookiecutter.package_name}}/blob/main/docs/CONTRIBUTING.md
 - you have updated the changelog (if needed):
-  https://github.com/{{gh_uname}}/{{project-name}}/blob/main/CHANGELOG.md
+  https://github.com/{{gh_uname}}/{{cookiecutter.package_name}}/blob/main/CHANGELOG.md
 -->
diff --git a/template/go/compose.yml b/template/go/compose.yml
@@ -1,12 +1,12 @@
 version: Compose specification
 
 service:
-    {{project-name}}:
+    {{cookiecutter.package_name}}:
         build: .
 
 networks:
-    {{project-name}}-net:
-        name: {{project-name}}-net
+    {{cookiecutter.package_name}}-net:
+        name: {{cookiecutter.package_name}}-net
         ipam:
             config:
                 -   subnet: 172.16.238.0/24
diff --git a/template/py/.github/PULL_REQUEST_TEMPLATE.md b/template/py/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/template/py/cargo-generate.toml b/template/py/cargo-generate.toml
diff --git a/template/py/fix-project-name.rhai b/template/py/fix-project-name.rhai
diff --git a/template/py/.dockerignore → ...cookiecutter.project_slug}}/.dockerignore b/template/py/.dockerignore → ...cookiecutter.project_slug}}/.dockerignore
diff --git a/template/py/.editorconfig → ...cookiecutter.project_slug}}/.editorconfig b/template/py/.editorconfig → ...cookiecutter.project_slug}}/.editorconfig
diff --git a/...e/py/.github/ISSUE_TEMPLATE/bug_report.md → ...ug}}/.github/ISSUE_TEMPLATE/bug_report.md b/...e/py/.github/ISSUE_TEMPLATE/bug_report.md → ...ug}}/.github/ISSUE_TEMPLATE/bug_report.md
@@ -37,7 +37,7 @@ Steps to reproduce the behavior:
 <!-- Please fill the following information. -->
 
 - OS: [e.g. Ubuntu 20.04]
-- {{project-name}} version: [e.g. 0.1.0]
+- {{cookiecutter.package_name}} version: [e.g. 0.1.0]
 
 ## Additional context
 

diff --git a/...late/py/.github/ISSUE_TEMPLATE/config.yml → ..._slug}}/.github/ISSUE_TEMPLATE/config.yml b/...late/py/.github/ISSUE_TEMPLATE/config.yml → ..._slug}}/.github/ISSUE_TEMPLATE/config.yml
diff --git a/....github/ISSUE_TEMPLATE/feature_request.md → ....github/ISSUE_TEMPLATE/feature_request.md b/....github/ISSUE_TEMPLATE/feature_request.md → ....github/ISSUE_TEMPLATE/feature_request.md
diff --git a/template/py/{{cookiecutter.project_slug}}/.github/PULL_REQUEST_TEMPLATE.md b/template/py/{{cookiecutter.project_slug}}/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,9 @@
+<!-- Please explain the changes you made -->
+
+<!--
+Please make sure:
+- you have read the contributing guidelines:
+  https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/blob/main/docs/CONTRIBUTING.md
+- you have updated the changelog (if needed):
+  https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/blob/main/CHANGELOG.md
+-->
diff --git a/template/py/.github/dependabot.yml → ...ter.project_slug}}/.github/dependabot.yml b/template/py/.github/dependabot.yml → ...ter.project_slug}}/.github/dependabot.yml
diff --git a/template/py/.github/renovate.json → ...tter.project_slug}}/.github/renovate.json b/template/py/.github/renovate.json → ...tter.project_slug}}/.github/renovate.json
diff --git a/template/py/.github/workflows/cd.yml → ...r.project_slug}}/.github/workflows/cd.yml b/template/py/.github/workflows/cd.yml → ...r.project_slug}}/.github/workflows/cd.yml
diff --git a/template/py/.github/workflows/ci.yml → ...r.project_slug}}/.github/workflows/ci.yml b/template/py/.github/workflows/ci.yml → ...r.project_slug}}/.github/workflows/ci.yml
diff --git a/template/py/.github/workflows/docker.yml → ...oject_slug}}/.github/workflows/docker.yml b/template/py/.github/workflows/docker.yml → ...oject_slug}}/.github/workflows/docker.yml
@@ -35,13 +35,13 @@ jobs:
                     context: .
                     load: true
                     tags: |
-                        ghcr.io/{{gh_uname}}/{{project-name}}:latest
-                        ghcr.io/{{gh_uname}}/{{project-name}}:${GITHUB_REF_NAME:1}
+                        ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:latest
+                        ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:${GITHUB_REF_NAME:1}
             -
                 name: Test it before Push
                 run: |
-                    docker run --rm ghcr.io/{{gh_uname}}/{{project-name}}:latest
-                    docker run --rm ghcr.io/{{gh_uname}}/{{project-name}}:${GITHUB_REF_NAME:1}
+                    docker run --rm ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:latest
+                    docker run --rm ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:${GITHUB_REF_NAME:1}
             -
                 name: Build and Push
                 uses: docker/build-push-action@v5
@@ -50,5 +50,5 @@ jobs:
                     platforms: linux/amd64,linux/arm64
                     push: true
                     tags: |
-                        ghcr.io/{{gh_uname}}/{{project-name}}:latest
-                        ghcr.io/{{gh_uname}}/{{project-name}}:${GITHUB_REF_NAME:1}
+                        ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:latest
+                        ghcr.io/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}:${GITHUB_REF_NAME:1}
diff --git a/template/py/.gitignore → .../{{cookiecutter.project_slug}}/.gitignore b/template/py/.gitignore → .../{{cookiecutter.project_slug}}/.gitignore
diff --git a/template/py/.pre-commit-config.yaml → ...er.project_slug}}/.pre-commit-config.yaml b/template/py/.pre-commit-config.yaml → ...er.project_slug}}/.pre-commit-config.yaml
diff --git a/template/py/CHANGELOG.md → ...{cookiecutter.project_slug}}/CHANGELOG.md b/template/py/CHANGELOG.md → ...{cookiecutter.project_slug}}/CHANGELOG.md
diff --git a/template/py/CODE_OF_CONDUCT.md → ...ecutter.project_slug}}/CODE_OF_CONDUCT.md b/template/py/CODE_OF_CONDUCT.md → ...ecutter.project_slug}}/CODE_OF_CONDUCT.md
diff --git a/template/py/CONTRIBUTING.md → ...okiecutter.project_slug}}/CONTRIBUTING.md b/template/py/CONTRIBUTING.md → ...okiecutter.project_slug}}/CONTRIBUTING.md
@@ -1,14 +1,14 @@
 # Contribution guidelines
 
-First off, thank you for considering contributing to {{project-name}}.
+First off, thank you for considering contributing to {{cookiecutter.project_slug}}.
 
 If your contribution is not straightforward, please first discuss the change you
 wish to make by creating a new issue before making the change.
 
 ## Reporting issues
 
 Before reporting an issue on the
-[issue tracker](https://github.com/{{gh_uname}}/{{project-name}}/issues),
+[issue tracker](https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues),
 please check that it has not already been reported by searching for some related
 keywords.
 
@@ -42,8 +42,8 @@ If the required subsection does not exist yet under **Unreleased**, create it!
 This is no different from other Python projects.
 
 ```shell
-git clone https://github.com/{{gh_uname}}/{{project-name}}
-cd {{project-name}}
+git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}
+cd {{cookiecutter.project_slug}}
 make test
 ```
 

diff --git a/template/py/Dockerfile → .../{{cookiecutter.project_slug}}/Dockerfile b/template/py/Dockerfile → .../{{cookiecutter.project_slug}}/Dockerfile
diff --git a/template/py/LICENSE-APACHE → ...ookiecutter.project_slug}}/LICENSE-APACHE b/template/py/LICENSE-APACHE → ...ookiecutter.project_slug}}/LICENSE-APACHE
diff --git a/template/py/LICENSE-MIT → ...{{cookiecutter.project_slug}}/LICENSE-MIT b/template/py/LICENSE-MIT → ...{{cookiecutter.project_slug}}/LICENSE-MIT
diff --git a/template/py/Makefile → ...py/{{cookiecutter.project_slug}}/Makefile b/template/py/Makefile → ...py/{{cookiecutter.project_slug}}/Makefile
diff --git a/template/py/README.md → ...y/{{cookiecutter.project_slug}}/README.md b/template/py/README.md → ...y/{{cookiecutter.project_slug}}/README.md
@@ -1,7 +1,7 @@
 # {{project-name}}
 
-[![CI](https://github.com/{{gh_uname}}/{{project-name}}/workflows/CI/badge.svg)](https://github.com/{{gh_uname}}/{{project-name}}/actions)
-[![Coverage Status](https://coveralls.io/repos/github/{{gh_uname}}/{{project-name}}/badge.svg?branch=main)](https://coveralls.io/github/{{gh_uname}}/{{project-name}}?branch=main)
+[![CI](https://github.com/{{cookiecutter.github_username}}/{{project-name}}/workflows/CI/badge.svg)](https://github.com/{{cookiecutter.github_username}}/{{project-name}}/actions)
+[![Coverage Status](https://coveralls.io/repos/github/{{cookiecutter.github_username}}/{{project-name}}/badge.svg?branch=main)](https://coveralls.io/github/{{cookiecutter.github_username}}/{{project-name}}?branch=main)
 [![PyPI version](https://badge.fury.io/py/{{project-name}}.svg)](https://badge.fury.io/py/{{project-name}})
 [![Python Versions](https://img.shields.io/pypi/pyversions/{{project-name}}.svg)](https://pypi.org/project/{{project-name}}/)
 

diff --git a/template/py/SECURITY.md → ...{{cookiecutter.project_slug}}/SECURITY.md b/template/py/SECURITY.md → ...{{cookiecutter.project_slug}}/SECURITY.md
diff --git a/template/py/compose.yml → ...{{cookiecutter.project_slug}}/compose.yml b/template/py/compose.yml → ...{{cookiecutter.project_slug}}/compose.yml
@@ -1,12 +1,12 @@
 version: Compose specification
 
 service:
-    {{project-name}}:
+    {{cookiecutter.project_slug}}:
         build: .
 
 networks:
-    {{project-name}}-net:
-        name: {{project-name}}-net
+    {{cookiecutter.project_slug}}-net:
+        name: {{cookiecutter.project_slug}}-net
         ipam:
             config:
                 -   subnet: 172.16.238.0/24
diff --git a/template/py/{{cookiecutter.project_slug}}/cookiecutter.json b/template/py/{{cookiecutter.project_slug}}/cookiecutter.json
@@ -0,0 +1,16 @@
+{
+    "project_name": "My Awesome Project",
+    "project_slug": "{{ cookiecutter.package_name | slugify }}",
+    "package_name": "{{ cookiecutter.project_slug | replace('-', '_') }}",
+    "short_description": "A nice python package",
+    "github_username": "your-org-or-username",
+    "full_name": "Firstname Lastname",
+    "email": "email@example.com",
+    "__prompts__": {
+        "package_name": "Select your project name",
+        "short_description": "Short description",
+        "github_username": "GitHub username or organization",
+        "full_name": "Author full name",
+        "email": "Author email"
+    }
+}
diff --git a/template/py/docs/usage.md → ...cookiecutter.project_slug}}/docs/usage.md b/template/py/docs/usage.md → ...cookiecutter.project_slug}}/docs/usage.md
diff --git a/template/py/pyproject.toml → ...ookiecutter.project_slug}}/pyproject.toml b/template/py/pyproject.toml → ...ookiecutter.project_slug}}/pyproject.toml
@@ -3,14 +3,14 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "{{project-name}}"
+name = "{{cookiecutter.project_slug}}"
 version = "0.0.1"
 description = "{{py_proj_desc}}"
 readme = "README.md"
 requires-python = ">=3.11"
 license = "MIT"
 authors = [
-    { name = "{{gh_uname}}" },
+    { name = "{{cookiecutter.github_username}}" },
 ]
 classifiers = [
     "Development Status :: 4 - Beta",
@@ -31,16 +31,16 @@ dev = [
 ]
 
 [project.urls]
-Documentation = "https://github.com/{{gh_uname}}/{{project-name}}#readme"
-Issues = "https://github.com/{{gh_uname}}/{{project-name}}/issues"
-Source = "https://github.com/{{gh_uname}}/{{project-name}}"
+Documentation = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}#readme"
+Issues = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues"
+Source = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}"
 
 [tool.pytest.ini_options]
 minversion = "6.0"
 addopts = [
     "-ra", # show all captured stdout/stderr
     "-q", # quiet
-    "--cov={{project-name}}", # report coverage of {{project-name}}
+    "--cov={{cookiecutter.project_slug}}", # report coverage of {{cookiecutter.project_slug}}
     "--cov-report=term-missing", # show missing coverage
     "--cov-report=html", # generate html coverage report
     "--cov-report=lcov", # generate lcov coverage report
@@ -53,16 +53,16 @@ markers = [
 ]
 
 [tool.coverage.run]
-source_pkgs = ["{{project-name}}", "tests"]
+source_pkgs = ["{{cookiecutter.package_name}}", "tests"]
 branch = true
 parallel = true
 omit = [
     "*/.venv/*"
 ]
 
 [tool.coverage.paths]
-{{project-name}} = ["src/{{project-name}}", "*/{{project-name}}/src/{{project-name}}"]
-tests = ["tests", "*/{{project-name}}/tests"]
+{{cookiecutter.package_name}} = ["src/{{cookiecutter.package_name}}", "*/{{cookiecutter.project_slug}}/src/{{cookiecutter.package_name}}"]
+tests = ["tests", "*/{{cookiecutter.project_slug}}/tests"]
 
 [tool.coverage.report]
 exclude_lines = [

diff --git a/template/py/ruff.toml → ...y/{{cookiecutter.project_slug}}/ruff.toml b/template/py/ruff.toml → ...y/{{cookiecutter.project_slug}}/ruff.toml
diff --git a/template/py/src/{{project-name}}/__init__.py → ...{{cookiecutter.package_name}}/__init__.py b/template/py/src/{{project-name}}/__init__.py → ...{{cookiecutter.package_name}}/__init__.py
diff --git a/template/py/src/{{project-name}}/app.py → .../src/{{cookiecutter.package_name}}/app.py b/template/py/src/{{project-name}}/app.py → .../src/{{cookiecutter.package_name}}/app.py
diff --git a/template/py/src/{{project-name}}/example.py → .../{{cookiecutter.package_name}}/example.py b/template/py/src/{{project-name}}/example.py → .../{{cookiecutter.package_name}}/example.py
diff --git a/template/py/tests/test_example.py → ...tter.project_slug}}/tests/test_example.py b/template/py/tests/test_example.py → ...tter.project_slug}}/tests/test_example.py
@@ -1,5 +1,5 @@
 import pytest
-from {{project-name}} import add, divide, multiply, subtract
+from {{cookiecutter.package_name}} import add, divide, multiply, subtract
 
 
 def test_add():