Repository navigation
Make public names consistent before the public release - #16
Merged
Merged
Conversation
`test` and `integration` share a private `_pytest` recipe, and the type checkers share `_typecheck`. Every CI step has a name, and the `test` job is now `unit-tests-and-type-checks`. Only `just pdc up` refetches the stack files. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Rename functions and arguments to match the endpoints and the rest of the client, make every not-found error a PDCNotFoundError, and fix the README where it disagreed with the code. Tests use one Test<Subject> class per function, and shared integration fixtures live in conftest. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
chrisjkuch
marked this pull request as ready for review
November 18, 2026 19:37
Collaborator
Author
|
@jayqi mostly just trying to tidy things up, let me know after this if there's anything you'd like to do before we make it public. |
…lease # Conflicts: # .github/workflows/ci.yml
jayqi
approved these changes
Nov 19, 2026
jayqi
left a comment
Collaborator
There was a problem hiding this comment.
Looks good. I fixed a minor merge conflict.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Renames functions, arguments and errors so the API matches PDC's endpoints and follows one convention. Also brings the README in line with the code and tidies the tests and tooling.
Changes
get_basefields→get_base_fields,create_changemaker_proposal→create_proposal,create_changemaker_proposal_version→create_proposal_version,register_file_upload→create_file.get_application_formtakesapplication_form_id.list_permission_grantsfilters bychangemaker_id,funder_short_codeandproposal_id.grantinstead ofspec.PDCNotFoundErrorand name the missing record.ChangemakerFieldValueBatchNotFoundErrorandTokenRequestErrorcan be imported frompdc_api_client.ensure_*_for_kc_orgis nowensure_*_for_keycloak_org.link_changemaker_to_proposalis gone in favor of the client function./sourcescoverage, theget_base_fieldsreturn type, the "other writes" list, and the retry behavior now match the code.Test<Subject>class per function, with methods namedtest_<behavior>. AGENTS.md now records this. Shared integration fixtures moved intoconftest.py.testandintegrationshare one private just recipe, and so do the type checkers.testjob is nowunit-tests-and-type-checks.just pdc uprefetches the stack files.Bonus:
integration_tests/pytest.ini.Notes
Risks: The renames break callers of 0.3.0. They are reversible with effort, and pdc-exchange needs about 110 call sites updated when it upgrades. The CHANGELOG lists every rename under Unreleased.
The version stays at 0.3.0. The release PR should bump it to 0.4.0.
🤖 Generated with Claude Code