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/06-ruff.md

View on GitHub
---
description: "The format and lint tasks and their paths, the [tool.ruff] configuration, the small lint rule set, and # fmt: off / # fmt: on for hand-written layout. Read before finishing any change to Python code, or when ruff reports something."
---

# ruff

---

## 1. Tasks

```bash
mise run format   # uvx ruff format <package_name> tests .mise/tasks .claude/skills/pywf-oss-base
mise run lint     # uvx ruff check --select F401,F821,F841 on the same paths, plus the one-import-per-statement check
```

Run `format`, then `lint`, before you finish any change to Python code.

The tasks cover only this repo's own code. Other folders in `.claude/skills/`, such as installed community skills, are third-party: never format or lint them, so they stay identical to their pinned commit.

The one-import-per-statement check is the base script `check_one_import_per_line.py`, because ruff cannot enforce this rule without also re-sorting imports. To split violations automatically:

```bash
python ${CLAUDE_SKILL_DIR}/../pywf-oss-base/scripts/check_one_import_per_line.py --paths <package_name> tests --fix
```

---

## 2. Configuration

`[tool.ruff]` in `pyproject.toml`:

- **Excluded paths:**
  - `<package_name>/vendor`, which holds copied third-party code;
  - `.claude/skills/*/assets`, which holds templates with placeholders.
- **`__init__.py` and `api.py` may have unused imports:** they are the re-exports.
- **The lint set is deliberately small:** unused imports (F401), undefined names (F821), unused variables (F841). Layout is the formatter's job; line length is not linted.

---

## 3. Keeping hand-written layout

Wrap a block in `# fmt: off` / `# fmt: on` when its layout carries meaning the formatter would destroy: field definitions in declarative models (dataclass, pydantic, ORM), lookup tables, matrices, and column-aligned test cases. Keep the fence as small as possible, at the indentation of the code it fences.
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