change: Reorganize as `griffe` and `griffelib` packages with uv workspaces #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 48 commits into main from b/migrate

+425 −119

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 force-pushed the b/migrate branch from fb90230 to e2ea8b8 Compare

January 18, 2026 13:49

johnslavik commented

View reviewed changes

docs/guide/users/navigating.md Outdated Show resolved Hide resolved

johnslavik added 7 commits

January 18, 2026 14:50


          Remove unnecessary change

0571dda


          Fix cross-ref

77b44fc


          Fix warning

e0f3490


          Fix quality checks

4886bdb


          Fix CLI glue code

ebca858


          Fix lint problems

38abea4


          Fix typing problems

8a1e655

johnslavik marked this pull request as ready for review

January 18, 2026 15:29

johnslavik added 16 commits

January 18, 2026 16:33


          Update paths to inventories

a02b3ed


          Use double quoted strings

4e53073


          Fix inventory paths again

09d0864


          Make API tests generic over packages

f50fd18


          Workaround single locations test

a4ce6fb


          More descriptive duty names

c71d034


          Fix lint problems

f37ffdc


          Fix test rewrite

0c5610c


          Remove public_objects fixture reference

0b1ca26


          Fix tests to new layout

449ff54


          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

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

Labels

None yet