Skip to content

MacHu-GWU/sqlalchemy_upsert_kit-project / .claude/skills/pywf-oss-base

pywf-oss-base

Flagged

Shared 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.

FileKindSize
SKILL.mdskill md6.5 KB
assets/community-skills.tomlconfig2.4 KB
assets/notebook-page-template.ipynbother1.1 KB
assets/raw-rst-cell.jsonconfig255 B
references/00-authoring-references.mdmarkdown6.3 KB
references/01-secrets.mdmarkdown3.0 KB
references/02-machine-setup.mdmarkdown3.2 KB
references/03-mise.mdmarkdown2.1 KB
references/04-python-versions.mdmarkdown1.8 KB
references/05-uv-dependencies.mdmarkdown2.0 KB
references/06-ruff.mdmarkdown1.9 KB
references/07-repo-layout.mdmarkdown2.3 KB
references/08-package-files.mdmarkdown3.9 KB
references/09-code-style.mdmarkdown5.6 KB
references/10-test-layout.mdmarkdown4.1 KB
references/11-test-writing.mdmarkdown2.1 KB
references/12-coverage.mdmarkdown1.1 KB
references/13-sphinx.mdmarkdown5.6 KB
references/14-docfly.mdmarkdown2.2 KB
references/15-furo.mdmarkdown1.4 KB
references/16-sphinx-design.mdmarkdown5.8 KB
references/17-nbsphinx.mdmarkdown5.0 KB
references/18-knowledge-channels.mdmarkdown3.8 KB
references/19-github-actions.mdmarkdown3.7 KB
references/20-codecov.mdmarkdown1.3 KB
references/21-readthedocs.mdmarkdown1.7 KB
references/22-versioning-and-changelog.mdmarkdown3.0 KB
references/23-release.mdmarkdown1.3 KB
references/24-dependency-upgrades.mdmarkdown3.2 KB
references/25-python-release-cycle.mdmarkdown1.4 KB
references/26-community-skills.mdmarkdown5.0 KB
references/27-skill-family-workflow.mdmarkdown6.5 KB
scripts/check_doc_xrefs.pyscript3.4 KB
scripts/check_one_import_per_line.pyscript4.2 KB
scripts/check_skill_family.pyscript6.5 KB
scripts/check_test_layout.pyscript6.2 KB
scripts/install_community_skill.pyscript8.6 KB
scripts/update_skill_index.pyscript4.1 KB

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.
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: 471kUpdated Claude CodeCodexVerifiedInstall
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: 471kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall