From 531218a15f1540c454222accbef497d1eebca532 Mon Sep 17 00:00:00 2001 From: Rajesh Date: Sun, 18 Oct 2026 19:17:12 +0530 Subject: [PATCH] chore: rename project references to python-project-template --- .devcontainer/devcontainer.json | 2 +- README.md | 8 ++++---- .../principle-4-link-to-code.md | 6 +++--- docs/dev/contributing/naming-conventions.md | 14 +++++++------- zensical.toml | 6 +++--- 5 files changed, 18 insertions(+), 18 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 8792101..0923188 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "devcontainer-python-template", + "name": "python-project-template", "build": { "context": ".", "dockerfile": "Dockerfile" diff --git a/README.md b/README.md index faf122f..dcf14c8 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
-

devcontainer-python-template

+

python-project-template

- + Docs @@ -35,10 +35,10 @@ Prerequisites: Docker + VS Code with the Dev Containers extension. ```bash # Clone the template -git clone https://github.com/HYP3R00T/devcontainer-python-template.git +git clone https://github.com/HYP3R00T/python-project-template.git # Enter the project folder -cd devcontainer-python-template +cd python-project-template # Open in VS Code code . diff --git a/docs/dev/contributing/documentation-principles/principle-4-link-to-code.md b/docs/dev/contributing/documentation-principles/principle-4-link-to-code.md index 220d182..1bbb5f3 100644 --- a/docs/dev/contributing/documentation-principles/principle-4-link-to-code.md +++ b/docs/dev/contributing/documentation-principles/principle-4-link-to-code.md @@ -22,8 +22,8 @@ Use full GitHub permalinks. Static documentation sites cannot resolve relative p **DO:** -- `https://github.com/HYP3R00T/devcontainer-python-template/blob/main/pyproject.toml` -- `https://github.com/HYP3R00T/devcontainer-python-template/blob/main/zensical.toml` +- `https://github.com/HYP3R00T/python-project-template/blob/main/pyproject.toml` +- `https://github.com/HYP3R00T/python-project-template/blob/main/zensical.toml` **DON'T:** @@ -36,4 +36,4 @@ When writing "Thinking" or "Journey" docs, link to specific commit SHAs. **DO:** -- "In [commit a1b2c3d](https://github.com/HYP3R00T/devcontainer-python-template/commit/a1b2c3d), we updated the test coverage threshold to keep CI quality gates clear" +- "In [commit a1b2c3d](https://github.com/HYP3R00T/python-project-template/commit/a1b2c3d), we updated the test coverage threshold to keep CI quality gates clear" diff --git a/docs/dev/contributing/naming-conventions.md b/docs/dev/contributing/naming-conventions.md index 87b01e7..fac919b 100644 --- a/docs/dev/contributing/naming-conventions.md +++ b/docs/dev/contributing/naming-conventions.md @@ -10,19 +10,19 @@ Use clear nouns that describe purpose. (GOOD) -- `devcontainer-python-template` - repository package name -- `devcontainer-python-template-utils` - optional helper package -- `devcontainer-python-template-cli` - optional CLI package +- `python-project-template` - repository package name +- `python-project-template-utils` - optional helper package +- `python-project-template-cli` - optional CLI package (AVOID) - `core` - too generic -- `devcontainer_python_template` - underscores are for import/module names, not distribution names -- `DevcontainerPythonTemplate` - wrong case +- `python_project_template` - underscores are for import/module names, not distribution names +- `PythonProjectTemplate` - wrong case Note: the Python import name (the `src/` folder) uses underscores as required by Python -(e.g. `devcontainer_python_template`), but the installable package name in `pyproject.toml` -uses hyphens (e.g. `devcontainer-python-template`). +(e.g. `python_project_template`), but the installable package name in `pyproject.toml` +uses hyphens (e.g. `python-project-template`). ## Modules (Files) diff --git a/zensical.toml b/zensical.toml index 59a5b89..7654a4f 100644 --- a/zensical.toml +++ b/zensical.toml @@ -1,8 +1,8 @@ [project] -site_name = "devcontainer-python-template" +site_name = "python-project-template" site_description = "Add your description here" -repo_name = "HYP3R00T/devcontainer-python-template" -repo_url = "https://github.com/HYP3R00T/devcontainer-python-template" +repo_name = "HYP3R00T/python-project-template" +repo_url = "https://github.com/HYP3R00T/python-project-template" site_author = "Rajesh Das" copyright = "Copyright © 2026 Rajesh Das"