Repository navigation
Prepare 5.2.0, the final release - #107
Conversation
config_resolver gets one last release and then no further work. Users need to hear about it where they will notice, so get_config() and from_string() now emit ConfigResolverDeprecationWarning, a DeprecationWarning subclass defined in config_resolver.exc and exported from the package. Importing the package stays silent. The warning uses stacklevel=3 so it is attributed to the caller's line, not to config_resolver; tests pin that down. The existing suite filters the warning in pytest.ini instead of handling it in each test. The obsolete log_print option, which pytest reports as unknown, is gone. Co-Authored-By: Claude <noreply@anthropic.com>
PyPI metadata should tell the truth about the project's state: - Development Status is now "7 - Inactive"; there will be no further work after this release. - The license classifier said LGPLv3, but LICENSE.txt and the license field have been MIT for years. The classifier now says MIT. - The package ships py.typed, so it gets the "Typing :: Typed" classifier. - The summary states that the project is unmaintained. - project.urls points to the stable docs, the changelog, the issue tracker and the repository. Co-Authored-By: Claude <noreply@anthropic.com>
Read the Docs "stable" still shows 5.0.0a1: there was no .readthedocs.yaml, and conf.py hard-coded that version. - Add .readthedocs.yaml. It installs a new "docs" dependency group with uv and fails on warnings. - Read the version from config_resolver/version.txt, the file setuptools already uses. - Replace sphinx_rtd_theme with the michel-albert-sphinx design system, and enable autosectionlabel and sphinx-autodoc-typehints. - Point intersphinx at current Python docs and at packaging. - Fix the docstring markup and cross-references the nitpicky build reported. - Build the docs in CI with -n -W. The docs dependencies are a uv dependency group, not an optional extra: the theme is a git URL, and PyPI rejects direct references in published metadata. Co-Authored-By: Claude <noreply@anthropic.com>
The README (the PyPI page) and the docs start page now open with a warning: the project is unmaintained, 5.2.0 is the final release, a short reason, and a link to the new "Alternatives and migration" page, first in the table of contents. That page covers each common use case with a short snippet: pydantic-settings for containerised services, plain ConfigParser for existing INI files, platformdirs + tomllib for a CLI tool's XDG cascade, a schema_version field instead of the version option, and an ownership-and-mode check instead of secure=True. It also shows how to silence the new warning while migrating. The snippets live in doc/migration/*.py and are included verbatim. tests/test_migration_snippets.py runs them. Tests whose third-party library is missing are skipped, so config_resolver gains no dependency. Co-Authored-By: Claude <noreply@anthropic.com>
Bump the version and add the 5.2.0 entry to both changelogs: the deprecation warning (including the effect on projects that run with -W error), the corrected license classifier, and the docs changes. 5.2.0 is a minor release: the API is unchanged and the only new behaviour is a warning. Co-Authored-By: Claude <noreply@anthropic.com>
The classifiers listed only 3.6. The test suite passes on 3.11-3.15 in CI and on 3.8-3.10 locally. 5.1.0 was tested on 3.6-3.9, and the new code uses only 3.6-compatible syntax (checked with vermin), so 3.6 and 3.7 stay listed even though current tooling cannot run them. Co-Authored-By: Claude <noreply@anthropic.com>
The cross-reference fixed earlier pushed the line past the limit. Co-Authored-By: Claude <noreply@anthropic.com>
`uv run sphinx-build` failed because Sphinx and the theme lived in a separate "docs" dependency group, which uv does not install by default. Move them into the default dev group, as x690 does, so a plain `uv sync` / `uv run sphinx-build` works locally, on Read the Docs and in CI. The docs CI job now mirrors x690's: it syncs with the latest supported Python, then runs sphinx-build. Co-Authored-By: Claude <noreply@anthropic.com>
|
Fixed in 2fc2150:
Checked on a fresh clone with a new venv: |
Host the docs at https://exhuma.github.io/config_resolver/ instead of Read the Docs, the same way x690 does: a new docs.yml workflow builds them with Sphinx on every push to master and deploys them with actions/deploy-pages. The CI workflow keeps checking the build on every push and pull request. - Remove .readthedocs.yaml. - Point the deprecation warning straight at the migration page on GitHub Pages, and update the test that checks the link. - Update project.urls, the README and both changelogs. Co-Authored-By: Claude <noreply@anthropic.com>
|
Moved the docs to GitHub Pages in 643b841, set up like x690:
CI is green, including the docs build. The deploy itself only runs on Pages is currently off for this repo. Before merging, enable it under Settings → Pages → Source: GitHub Actions. Otherwise the first deploy fails, and you'll need to re-run the Docs workflow manually. The PR description's "Left for you" list is updated. |
Prepares 5.2.0, the final release of config_resolver. It says plainly that the project is unmaintained, shows how to replace it, and warns at runtime. Nothing is tagged or published: that's left for after review (see the end).
What changes
Runtime warning
ConfigResolverDeprecationWarning(DeprecationWarning)inconfig_resolver/exc.py, exported from the package.get_config()andfrom_string()emit it on every call withstacklevel=3, so it points at the caller's line. Importing the package does not warn.tests/test_deprecation.pychecks both functions, the caller filename and line (a mutation tostacklevel=2makes those tests fail), the docs URL in the message, the subclass relation, thatpython -W error -c "import config_resolver"passes, and that the filter shown in the docs silences it.pytest.ini; no existing test was edited. The obsoletelog_printoption (pytest reported it as unknown) is removed.Documentation
README.rst(the PyPI page) and the docs start page, which includes the README, open with awarningadmonition: unmaintained, final release, a short reason, and a link to the migration page.doc/migration.rst("Alternatives and migration"), first in the toctree:env_prefix,env_nested_delimiter="__",secrets_dir="/run/secrets",SecretStr, exit onValidationError)ConfigParser().read()over config_resolver's own path list;read()returns the files it loaded (same asmeta.loaded_files)platformdirs+tomllib(with atomlifallback) for the system → user → explicit cascade, including theBIRD_FEEDER_CONFIGenv var, returning(config, loaded_files)version: aschema_version: Literal[2]pydantic field, plus a plain check without pydanticsecure=True: anos.statcheck of owner and mode, with a note that container secret mounts are 0444/0644 and protected by the mount, not the modedoc/migration/and are included withliteralinclude.tests/test_migration_snippets.pyruns them; tests whose library is missing are skipped, so config_resolver gains no dependency..github/workflows/docs.ymlbuilds with Sphinx on every push tomasterand deploys withactions/deploy-pagesdocsjob in the main workflow checks the build (-n -W) on every push and PRdevgroup, so plainuv sync/uv run sphinx-buildworks.readthedocs.yamlis gone; README,project.urls, the changelogs and the warning message point to https://exhuma.github.io/config_resolver/conf.pyreads the version fromconfig_resolver/version.txt(it was hard-coded to5.0.0a1)Packaging and release prep
version.txt→5.2.0.Development Status :: 7 - InactiveLGPLv3→MIT, matchingLICENSE.txtTyping :: Typed(the package shipspy.typed)project.urlslists Documentation, Changelog, Issues and Repository.CHANGESanddoc/changelog.rsthave a 5.2.0 entry: final release, the deprecation warning (including that projects running with-W errornow fail on calls), the license fix, and the docs.sphinx-build -n -W).Verification
Test suite (dev env, Python 3.13)
The 3 skips are the pre-existing JSON skip and the two pydantic-settings snippet tests (that library isn't in the dev env).
CI on 643b841: all green
Older Pythons, run locally
uv can no longer download 3.6 or 3.7. The 3.6/3.7 classifiers rest on 5.1.0's CI matrix (3.6–3.9) plus
verminshowing the new code needs only 3.6. 3.10 left the CI matrix because endoflife.date lists it as EOL.Migration snippets in throwaway uv environments
Versions resolved: pydantic 2.14.1, pydantic-settings 2.16.1, platformdirs 4.13.6.
Docs and package build
I couldn't take screenshots of the rendered pages because no browser was available. I only checked the HTML structure.
Quartermaster kits applied
Resolved via
resolve_kitsat the start; every kit was served at major version v1:module-python-library: metadata, README, changelog, versioning/deprecation, examples-as-tests, docs build in CImodule-docs-sphinx: theme, required extensions, version sourcing,-W, no hard-coded versionmodule-hosting-readthedocs: applied at first, then dropped when the docs moved to GitHub Pages (no Pages kit exists; x690's setup was copied)module-documentation: 80-column RST, semantic line breaks, changelog prosemodule-changelog: entry wording and size tiers; clproc itself was not adopted (see deviations)module-version-control: atomic 50/72 commits without Conventional Commits type prefixesmodule-testing-strategyandmodule-code-style-python: "Ensure …" test docstrings, docstring format, no__future__importDeliberate deviations
requires-pythonstays>=3.6(hard constraint), although the library kit wants every supported version tested in CI. CI'sversionsjob will keep printing its "requires-python is below the oldest supported CPython" warning.devdependency group, not adocsoptional extra. The theme is agit+httpsURL, and PyPI rejects direct references in published metadata. Keeping it indevmatches x690.changelog.inmigration. That's tooling for future releases, so I kept the hand-writtenCHANGESanddoc/changelog.rst. The license fix has its own changelog entry, even though the kit keeps packaging metadata out of changelogs: you asked for it, and a project's license is something users care about. Drop it if you disagree.pypi_tokensecret rather than Trusted Publishing. The kits ask for these, but they're infrastructure for future releases.Left for you
docs.ymldeploys on the merge push. If you merge first, re-run "Docs" from the Actions tab (workflow_dispatch) once Pages is on./migration.htmlare live. The warning message links to the migration page.v5.2.0and push the tag. The existingpublishjob uploads to PyPI with thepypi_tokensecret, or publish by hand if you prefer.🤖 Generated with Claude Code