change: Split to `griffe` + `griffecli` + `griffelib` uv workspace #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Open

johnslavik wants to merge 59 commits into main from b/migrate

Member

johnslavik commented Nov 30, 2025 •

edited

Loading

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

johnslavik force-pushed the b/migrate branch from cc4c9c5 to e9221d0 Compare

November 30, 2025 19:53

This comment was marked as outdated.

Sign in to view

Copilot AI mentioned this pull request

change: Reorganize as griffe and griffelib packages with uv workspaces #435

Merged

2 tasks

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

Copilot AI mentioned this pull request

Fix pyproject.toml workspace config and restore griffe CLI branding #436

Merged

2 tasks

This comment was marked as outdated.

Sign in to view

Member Author

johnslavik commented Dec 1, 2025

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

Copilot AI mentioned this pull request

[WIP] Change: Reorganize as griffe and griffelib packages with uv workspaces #437

Closed

10 tasks

Copilot AI commented Dec 1, 2025

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

pawamoy force-pushed the b/migrate branch from e254389 to 1c3b869 Compare

December 2, 2025 14:40

pawamoy reviewed

View reviewed changes

packages/griffecli/src/griffecli/__init__.py Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

packages/griffelib/src/griffelib/_internal/diff.py Outdated Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

packages/griffelib/src/griffe/_internal/git.py Outdated Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

packages/griffelib/src/griffe/_internal/loader.py Outdated Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

scripts/gen_griffe_json.py Outdated Show resolved Hide resolved

pawamoy reviewed

View reviewed changes

scripts/gen_structure_docs.py Outdated Show resolved Hide resolved

Member Author

johnslavik commented Jan 7, 2026

I'm going over the whole pipeline (docs, usage, etc) now, addressing these and other issues on the way.

johnslavik and others added 11 commits

January 18, 2026 12:41


          Fix NameError & reformat everything

8239fd9


          Apply suggestions from code review

272cd11


          Run migration script

e951084


          Initial plan

b2dad08


          Fix griffelib/griffecli separation and add proper exports

72b1bbd

Co-authored-by: johnslavik <[email protected]>


          Fix test imports and paths for new package structure

6b829c8

Co-authored-by: johnslavik <[email protected]>


          Address code review feedback on comments and documentation

bb98dca

Co-authored-by: johnslavik <[email protected]>


          Add version locking for griffe's dependencies on griffelib and griffecli

95c310e

Co-authored-by: johnslavik <[email protected]>


          Use double brackets for version interpolation and re-export griffelib…

538c553

…[pypi]

Co-authored-by: johnslavik <[email protected]>


          Initial plan

3b28334


          Fix missing pyproject.toml config and CLI program name

e080e57

Co-authored-by: johnslavik <[email protected]>

johnslavik added 6 commits

January 18, 2026 19:22


          Fix import

e90f3c1


          Improve test structure

01d4d7c


          Workaround pytest moodiness

8d91988


          Fix problems with building

333a1b6

`uv build --all` now works


          Fix comment

b455adf


          Update the documentation

e44a595

Member Author

johnslavik commented Jan 18, 2026 •

edited

Loading

@pawamoy, I'd say this is ready.

The documentation changes are not complete, but I suggest we iterate on the docs later.
LMK if you have any questions/concerns.

I'd also say let's not release this yet before the documentation is fully updated.

Member Author

johnslavik commented Jan 18, 2026 •

edited

Loading

We can also add a test to our API tests to cover the scenario where griffelib is the only thing installed and one tries to import griffecli stuff.

johnslavik commented

View reviewed changes

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved


          Apply suggestions from code review

ce2c62e

pawamoy requested changes

View reviewed changes

docs/guide/contributors/architecture.md Show resolved Hide resolved

docs/installation.md Outdated Show resolved Hide resolved

docs/installation.md Outdated Show resolved Hide resolved

packages/griffecli/pyproject.toml Show resolved Hide resolved

packages/griffecli/pyproject.toml Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/debug.py Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

packages/griffelib/src/griffe/_internal/finder.py Outdated Show resolved Hide resolved

johnslavik and others added 3 commits

January 19, 2026 16:01


          Apply suggestions from code review

87ce03f

Thanks!

Co-authored-by: Timothée Mazzucotelli <[email protected]>


          Update example comment in Griffe finder

b550102

Co-authored-by: Timothée Mazzucotelli <[email protected]>


          Keep original descriptions

6f3b755

johnslavik requested a review from pawamoy

January 19, 2026 15:13

johnslavik and others added 2 commits

January 19, 2026 16:44


          Revert one suggestion

b3cf2f3


          Add "griffe" to version debug check candidates

524f534

Co-authored-by: Timothée Mazzucotelli <[email protected]>

Member Author

johnslavik commented Jan 19, 2026

Perhaps we can also add "griffecli" in debug checks. Will do that.

pawamoy mentioned this pull request

No type or annotation for parameter 'channel' #442

Open

johnslavik changed the title ~~change: Reorganize as griffe and griffelib packages with uv workspaces~~ change: Split to griffe, griffecli and griffelib uv workspace

johnslavik changed the title ~~change: Split to griffe, griffecli and griffelib uv workspace~~ change: Split to griffe + griffecli + griffelib uv workspace

johnslavik added 4 commits

February 1, 2026 09:05


          Remove hardcoded part from finder logic

ae5672b


          Fix test_meson_python_file_handling

dc6a270


          Add more packages to debug info

c08cc96


          Workaround UP007

fa3ed5c

Member Author

johnslavik commented Feb 1, 2026 •

edited

Loading

We are suddenly hit with failing UP007 checks (PEP 604 type annotation syntax). I added it to ignored rules in this PR because it is out of scope. I'll fix it in a separate PR.

Edit: Also added a type check ignore.


          Workaround an unrelated typing problem

e46a7a0

johnslavik force-pushed the b/migrate branch from ab73e42 to e46a7a0 Compare

February 1, 2026 08:51

johnslavik commented

View reviewed changes

tests/test_finder.py Outdated Show resolved Hide resolved


          Fix comment in test

102affa

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet