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/24-dependency-upgrades.md

View on GitHub
---
description: "The dependency upgrade process: finding outdated and unmaintained packages, judging each upgrade, packages that move together, applying the change, and the regression checks that prove it. Read when upgrading or replacing a dependency, or when asked whether a new version is worth it."
---

# Dependency Upgrades

How constraints are written is in `05-uv-dependencies.md`. This file is about changing them.

---

## 1. Find what is outdated

```bash
uv tree --outdated --depth 1
```

It lists each direct dependency with its locked version, plus `(latest: vX)` when a newer one exists; "latest" already respects `requires-python`.

**Unmaintained packages do not show up here.** Every few upgrades, also check each direct dependency's last release date on PyPI (`https://pypi.org/pypi/<dist_name>/json`). Replace a package with no release in about two years whose maintainers point to a successor.

---

## 2. Judge each upgrade

Read each outdated package's changelog from the locked version to the latest, and answer:

1. **Breaking changes that touch this repo,** checked against how the repo uses the package: its config, command-line flags, and imported APIs.
2. **Requirements:** the package's Python floor, and minimum versions of shared dependencies (a theme needs a given Sphinx; a pytest plugin, a given pytest).
3. **Gains:** security fixes, bug fixes that affect this repo, features worth adopting.
4. **Maintenance health:** last release, last commit, whether issues get answered.

**Verdict:** **upgrade** with the new constraint, **hold** with the reason, or **replace** with the successor.

**More than two packages:** delegate the changelog reading to a subagent, require a cited source for every version number and breaking change, and spot-check the versions against PyPI yourself.

**Packages that move together:** Sphinx with its theme and extensions (furo, sphinx-design, nbsphinx, sphinx-jinja, docfly); pytest with pytest-cov.

---

## 3. Apply

1. Edit the constraints in `pyproject.toml`, following `05-uv-dependencies.md`.
2. `uv lock --upgrade-package <dist_name>` per package (or `uv lock --upgrade` for all), then `mise run inst`.
3. `mise run export`, to refresh `requirements*.txt`.
4. For a renamed or replaced package, update every import and mention: `.mise/tasks/*.py`, `mise.toml` task descriptions, the docs, and the skill references.

---

## 4. Regression checks

| Area | Check |
| :--- | :--- |
| Tests | `mise run cov` passes with no new deprecation warnings. One test file run directly proves `run_cov_test` still works (`10-test-layout.md`). |
| Code | `mise run lint` |
| Docs build | `mise run build-doc` shows no new warnings, and the cross-reference check reports 0 unresolved (`13-sphinx.md`). |
| Docs look | With the visual check of `13-sphinx.md`, the sample pages in `docs/source/` (reStructuredText, notebook, sphinx-design gallery) render: tabs switch, dropdowns open, the jinja table is filled, raw cells render. For a theme upgrade, check light and dark mode (`15-furo.md`). |
| CI | After pushing, the whole matrix passes and Codecov receives the report (`19-github-actions.md`, `20-codecov.md`). |

The changelog entry for an upgrade follows the category table in `22-versioning-and-changelog.md`.
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