Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "devcontainer-python-template",
"name": "python-project-template",
"build": {
"context": ".",
"dockerfile": "Dockerfile"
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<div align="center">
<h1>devcontainer-python-template</h1>
<h1>python-project-template</h1>
<p>
<a href="https://hyp3r00t.github.io/devcontainer-python-template/">
<a href="https://hyp3r00t.github.io/python-project-template/">
<img alt="Docs" src="https://img.shields.io/badge/docs-online-0A66C2?style=for-the-badge" />
</a>
<a href="https://github.com/sponsors/HYP3R00T">
Expand Down Expand Up @@ -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 .
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:**

Expand All @@ -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"
14 changes: 7 additions & 7 deletions docs/dev/contributing/naming-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
6 changes: 3 additions & 3 deletions zensical.toml
Original file line number Diff line number Diff line change
@@ -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 &copy; 2026 Rajesh Das"

Expand Down
Loading