Skip to content

Commit 7525bc1

Browse files
committed
Rename repo to drc-python-template
1 parent c2543a0 commit 7525bc1

File tree

14 files changed

+31
-30
lines changed

14 files changed

+31
-30
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/design_research_python_template/__init__.py`.
42+
`src/drc_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: 3 additions & 2 deletions
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/design_research_python_template --cov-report=term --cov-report=json:artifacts/coverage/coverage.json -q
66+
PYTHONPATH=src $(PYTEST) --cov=src/drc_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
@@ -91,6 +91,7 @@ release-check: check-python
9191
ci: qa coverage docstrings-check docs-check run-example release-check
9292

9393
clean:
94-
rm -rf .coverage .mypy_cache .pytest_cache .ruff_cache artifacts build dist docs/_build src/design_research_python_template.egg-info
94+
rm -rf .coverage .mypy_cache .pytest_cache .ruff_cache artifacts build dist docs/_build
95+
find src -maxdepth 2 -type d -name "*.egg-info" -prune -exec rm -rf {} + 2>/dev/null || true
9596
find . -type d -name "__pycache__" -prune -exec rm -rf {} + 2>/dev/null || true
9697
find . -type f \( -name "*.pyc" -o -name ".coverage.*" \) -exec rm -f {} + 2>/dev/null || true

README.md

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

3-
`design-research-python-template` is a compact starter for typed Python
3+
`drc-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.
@@ -43,7 +43,7 @@ make repro
4343
|- docs/
4444
|- examples/
4545
|- scripts/
46-
|- src/design_research_python_template/
46+
|- src/drc_python_template/
4747
|- tests/
4848
|- AGENTS.md
4949
|- CONTRIBUTING.md

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:: design_research_python_template
4+
.. automodule:: drc_python_template
55
:members:
66
:undoc-members:
77
:show-inheritance:

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
ROOT = Path(__file__).resolve().parents[1]
99
sys.path.insert(0, str(ROOT / "src"))
1010

11-
project = "design-research-python-template"
12-
copyright = "2026, design-research-python-template contributors"
13-
author = "design-research-python-template contributors"
11+
project = "drc-python-template"
12+
copyright = "2026, drc-python-template contributors"
13+
author = "drc-python-template contributors"
1414

1515
extensions = [
1616
"sphinx.ext.autodoc",

docs/index.rst

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

4-
`design-research-python-template` is a reusable baseline for typed Python
4+
`drc-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 design_research_python_template import build_default_blueprint, describe_project
5+
from drc_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("design-research-python-template")
10+
blueprint = build_default_blueprint("drc-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 = "design-research-python-template"
6+
name = "drc-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/design-research-python-template"
44-
Repository = "https://github.com/cmudrc/design-research-python-template"
45-
Issues = "https://github.com/cmudrc/design-research-python-template/issues"
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"
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-
design_research_python_template = ["py.typed"]
55+
drc_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 = ["design_research_python_template"]
82+
packages = ["drc_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 "design_research_python_template" not in API_PATH.read_text(encoding="utf-8"):
61+
elif "drc_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

File renamed without changes.

0 commit comments

Comments
 (0)