Imported from bernard-ng/drc-names-classifier (
AGENTS.md). Install upstream withnpx skills add bernard-ng/drc-names-classifier. Copyright stays with the author.
Repository Guidelines
Project Structure & Module Organization
- Source code lives in
src/drc_names_classifier/, using a standard Python package layout. - Project metadata and build configuration are in
pyproject.toml.
Build, Test, and Development Commands
- If you use uv (see
uv.lock),uv syncinstalls dependencies anduv run drc-names-classifierruns the entry point. - Run
uv run pyrightanduv run ruff check .to validate changes end-to-end.
Coding Style & Naming Conventions
- Use Python 3.13 syntax and type hints when introducing new functions.
- Indentation: 4 spaces; line length: keep lines reasonably short (around 88–100 chars).
- Use
snake_casefor modules and functions,PascalCasefor classes, andUPPER_SNAKE_CASEfor constants. - Prefer small, focused functions;