MacHu-GWU/sqlalchemy_upsert_kit-project / .claude/skills/pywf-oss-base
pywf-oss-base
FlaggedShared conventions, references, and scripts of the pywf-oss skills for pywf open-source Python libraries: setup, layout, code style, tests, user docs and the agent skills that hold API and maintenance knowledge, CI and hosting, release, dependencies, and secrets. Load it before ad-hoc work on modules, tests, or docs in such a repo, for a question about these conventions, or when unsure which pywf-oss skill fits a job.
references/07-repo-layout.md
View on GitHub---
description: "The top-level tree of a template repo: what each folder and config file is for, which outputs are generated and which are committed, and the two blocks of CLAUDE.md. Read when deciding where a new top-level file or folder goes, what a root file is for, or whether a generated file is committed."
---
# Repository Layout
---
## 1. Tree
```text
<package_name>-project/
├── <package_name>/ # the importable package
├── tests/ # unit tests, mirroring <package_name>/
├── tests_int/ # optional: integration tests against real external services
├── tests_load/ # optional: load tests
├── docs/source/ # Sphinx source
├── .mise/tasks/*.py # Python scripts behind mise tasks
├── .claude/ # Claude Code settings, launch.json (docs preview server), and skills:
│ └── skills/ # pywf-oss-* (template), pypi-<package_name> (API), <maintain_prefix>-* (maintenance)
├── .github/workflows/main.yml # CI
├── pyproject.toml # metadata, dependencies, tool config (ruff, pytest)
├── mise.toml # tools, tasks, env vars
├── uv.lock # generated
├── requirements*.txt # generated by `mise run export`
├── .coveragerc / codecov.yml # coverage config
├── .readthedocs.yml # Read the Docs build
├── README.rst # short: what, install, a few examples, links
├── release-history.rst # changelog
├── AUTHORS.rst / LICENSE.txt
└── CLAUDE.md # project guide for AI: a project block and a template block
```
---
## 2. Generated outputs
| Path | Committed? |
| :--- | :--- |
| `uv.lock`, `requirements*.txt` | yes |
| `docs/source/api/` | yes, and regenerated on every docs build |
| `htmlcov/`, `docs/build/`, `dist/`, `build/`, `tmp/`, `*.egg-info` | no |
Never edit a generated file by hand. Change its source, and regenerate it.
---
## 3. `CLAUDE.md`
- **The project block** holds facts about this library. Edit it freely.
- **The template block,** between the `<!-- BEGIN pywf-oss template block` and `<!-- END pywf-oss template block -->` markers, is shared by every template repo and replaced as a whole on a template upgrade. Do not edit it per repo.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 471k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |