Scaffold a Python Library

Use a src/ layout so tests run against the installed package, not the working tree.

your-library/
├── src/
│   └── your_library/
│       ├── __init__.py        # defines the public API (__all__)
│       └── py.typed           # ship type information (PEP 561)
├── tests/
│   ├── unit/
│   └── api/                   # exercise the public API as a consumer
├── pyproject.toml
├── README.md
└── .gitignore

Initial Config

• pyproject.toml with an explicit build backend (hatchling), uv, ruff, mypy, pytest config — see ceh-python-library:packaging and ceh-python-library:python-library-environment.
• Keep dependencies = [] minimal; no web-service deps. Define __all__ in __init__.py from the start.

Agent instruction file

Claude Code reads CLAUDE.md, not AGENTS.md. If the repo already has an AGENTS.md for other coding agents, do not duplicate it — create a CLAUDE.md that imports it, so both tools read one source:

@AGENTS.md

Add any Claude-specific instructions below the import. A symlink also works, but on Windows it needs Administrator or Developer Mode, so prefer the import. If there is no AGENTS.md, just write CLAUDE.md directly.

.gitignore

.venv/
.env
.env.*
!.env.example
__pycache__/
*.pyc
*.egg-info/
.coverage
.pytest_cache/
.mypy_cache/
.ruff_cache/
dist/
build/
.DS_Store