Skip to content

Commit 4dac7a0

Browse files
committed
Rename template to python-template
1 parent bb18071 commit 4dac7a0

File tree

15 files changed

+34
-37
lines changed

15 files changed

+34
-37
lines changed

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ merging.
3939
## Public Vs Private Boundaries
4040

4141
- The supported public surface is whatever is re-exported from
42-
`src/drc_python_template/__init__.py`.
42+
`src/python_template/__init__.py`.
4343
- Prefer adding new public behavior to stable top-level modules before creating
4444
deeper internal package trees.
4545
- If you add internal helper modules later, prefix them with `_` and keep them

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ qa: lint fmt-check type test
6363

6464
coverage: check-python
6565
mkdir -p artifacts/coverage
66-
PYTHONPATH=src $(PYTEST) --cov=src/drc_python_template --cov-report=term --cov-report=json:artifacts/coverage/coverage.json -q
66+
PYTHONPATH=src $(PYTEST) --cov=src/python_template --cov-report=term --cov-report=json:artifacts/coverage/coverage.json -q
6767
$(PYTHON) scripts/check_coverage_thresholds.py --coverage-json artifacts/coverage/coverage.json
6868

6969
docstrings-check: check-python

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# drc-python-template
1+
# python-template
22

3-
`drc-python-template` is a compact starter for typed Python
3+
`python-template` is a compact starter for typed Python
44
libraries. It borrows the shared project shape from
55
`design-research-agents` and `design-research-problems`, but keeps the initial
66
surface area small enough to customize quickly.
@@ -67,7 +67,7 @@ make repro
6767
│ ├── check_docs_consistency.py
6868
│ └── check_google_docstrings.py
6969
├── src
70-
│ └── drc_python_template
70+
│ └── python_template
7171
│ ├── __init__.py
7272
│ ├── core.py
7373
│ └── py.typed
@@ -108,10 +108,10 @@ has a specific job:
108108
- `scripts/check_docs_consistency.py` verifies that the docs tree and package references stay in sync.
109109
- `scripts/check_google_docstrings.py` checks for required module, class, and function docstrings.
110110
- `src/` is the source root for the `src`-layout package.
111-
- `src/drc_python_template/` contains the installable Python package itself.
112-
- `src/drc_python_template/__init__.py` defines the curated public import surface.
113-
- `src/drc_python_template/core.py` contains the small example implementation shipped with the template.
114-
- `src/drc_python_template/py.typed` marks the package as PEP 561 typed for downstream tooling.
111+
- `src/python_template/` contains the installable Python package itself.
112+
- `src/python_template/__init__.py` defines the curated public import surface.
113+
- `src/python_template/core.py` contains the small example implementation shipped with the template.
114+
- `src/python_template/py.typed` marks the package as PEP 561 typed for downstream tooling.
115115
- `tests/` contains the pytest suite that protects the public behavior.
116116
- `tests/test_core.py` tests the package's example core behavior.
117117
- `tests/test_public_api.py` keeps the top-level exports explicit and stable.

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
API Reference
22
=============
33

4-
.. automodule:: drc_python_template
4+
.. automodule:: python_template
55
:members:
66
:undoc-members:
77
:show-inheritance:

docs/conf.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
ROOT = Path(__file__).resolve().parents[1]
1515
sys.path.insert(0, str(ROOT / "src"))
1616

17-
project = "drc-python-template"
18-
copyright = "2026, drc-python-template contributors"
19-
author = "drc-python-template contributors"
17+
project = "python-template"
18+
copyright = "2026, python-template contributors"
19+
author = "python-template contributors"
2020

2121
extensions = [
2222
"sphinx.ext.autodoc",
@@ -51,10 +51,7 @@
5151
html_css_files = ["custom.css"]
5252
html_logo = "drc.png"
5353
html_title = project
54-
if html_theme == "sphinx_rtd_theme":
55-
html_theme_options = {"logo_only": False}
56-
else:
57-
html_theme_options = {}
54+
html_theme_options = {"logo_only": False} if html_theme == "sphinx_rtd_theme" else {}
5855

5956
_VIEWPORT_META_RE = re.compile(r'<meta name="viewport"[^>]*>', re.IGNORECASE)
6057

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
drc-python-template
1+
python-template
22
===================
33

4-
`drc-python-template` is a reusable baseline for typed Python
4+
`python-template` is a reusable baseline for typed Python
55
packages. It keeps the starting point small while still shipping the same core
66
developer ergonomics used in the sibling design research repositories.
77

examples/basic_usage.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
from __future__ import annotations
44

5-
from drc_python_template import build_default_blueprint, describe_project
5+
from python_template import build_default_blueprint, describe_project
66

77

88
def main() -> None:
99
"""Print the default project summary."""
10-
blueprint = build_default_blueprint("drc-python-template")
10+
blueprint = build_default_blueprint("python-template")
1111
print(describe_project(blueprint))
1212

1313

pyproject.toml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools>=77", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "drc-python-template"
6+
name = "python-template"
77
version = "0.1.0"
88
description = "An opinionated starter template for typed Python libraries"
99
readme = "README.md"
@@ -40,9 +40,9 @@ dev = [
4040
]
4141

4242
[project.urls]
43-
Homepage = "https://github.com/cmudrc/drc-python-template"
44-
Repository = "https://github.com/cmudrc/drc-python-template"
45-
Issues = "https://github.com/cmudrc/drc-python-template/issues"
43+
Homepage = "https://github.com/cmudrc/python-template"
44+
Repository = "https://github.com/cmudrc/python-template"
45+
Issues = "https://github.com/cmudrc/python-template/issues"
4646

4747
[tool.setuptools]
4848
package-dir = { "" = "src" }
@@ -52,7 +52,7 @@ include-package-data = true
5252
where = ["src"]
5353

5454
[tool.setuptools.package-data]
55-
drc_python_template = ["py.typed"]
55+
python_template = ["py.typed"]
5656

5757
[tool.pytest.ini_options]
5858
addopts = "-q"
@@ -79,7 +79,7 @@ convention = "google"
7979
"tests/*.py" = ["D"]
8080

8181
[tool.mypy]
82-
packages = ["drc_python_template"]
82+
packages = ["python_template"]
8383
python_version = "3.12"
8484
warn_unused_configs = true
8585
check_untyped_defs = true

scripts/check_docs_consistency.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def validate_docs_tree() -> list[str]:
5858

5959
if not API_PATH.exists():
6060
errors.append("docs/api.rst is missing.")
61-
elif "drc_python_template" not in API_PATH.read_text(encoding="utf-8"):
61+
elif "python_template" not in API_PATH.read_text(encoding="utf-8"):
6262
errors.append("docs/api.rst does not reference the package module.")
6363
return errors
6464

0 commit comments

Comments
 (0)