griffe icon indicating copy to clipboard operation
griffe copied to clipboard

change: Reorganize as `griffe` and `griffelib` packages with uv workspaces

Open johnslavik opened this issue 4 weeks ago • 7 comments

Continuation of #431, based on #433, closes #408 Migration script: https://gist.github.com/johnslavik/76d556a427033c4de2d236d67aa05b8f

johnslavik avatar Nov 30 '25 19:11 johnslavik

Let's try Copilot here

johnslavik avatar Nov 30 '25 20:11 johnslavik

@copilot We've migrated griffe to 3 packages exposed by griffe package in a backward-compatible way, all bound by uv dynamic versioning that ensures compatibility. griffecli is supposed to only implement and expose CLI (which needs proper configuration in pyproject.toml) and depend on griffelib=={{version}}. griffelib is supposed depend on nothing and implement the necessary logic. griffe is supposed to be a backward-compatible package depending on both griffelib and griffecli, with all the previous packaging and runtime behaviors in regular use as before the migration.

Fix any instances of name errors (import griffe, but then griffelib is used, etc.), inconsistencies caused by the migration, and any references broken by the migration script. Make sure that the griffecli's init module is correct. Do complete whatever the migration script missed, making sure the migration is fully complete and backward-compatible. Update the documentation to reflect new changes, if necessary. Document all changes that you've made.

johnslavik avatar Nov 30 '25 20:11 johnslavik

@johnslavik I've opened a new pull request, #435, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot avatar Nov 30 '25 20:11 Copilot

@copilot Add missing configuration from pyproject.toml (check CI failures) and make sure that we promote the old way of running things (griffe check, not griffecli check; python -m griffe, not python -m griffecli) -- but document that it is possible to use python -m griffecli instead of python -m griffe where it makes sense.

johnslavik avatar Nov 30 '25 21:11 johnslavik

@johnslavik I've opened a new pull request, #436, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot avatar Nov 30 '25 21:11 Copilot

@copilot Look at https://github.com/mkdocstrings/griffe/actions/runs/19806731977/job/56741990187?pr=434. Fix all incorrect refs

johnslavik avatar Dec 01 '25 00:12 johnslavik

@johnslavik I've opened a new pull request, #437, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot avatar Dec 01 '25 00:12 Copilot