Skip to content

Refurbish the API client library #28

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
Merged
jakedialpad merged 85 commits into from
Jun 12, 2025
Merged

Refurbish the API client library #28

jakedialpad merged 85 commits into from
Jun 12, 2025

Conversation

@jakedialpad
Copy link
Collaborator

@jakedialpad jakedialpad commented Jun 12, 2025 •
edited
Loading

This is more-or-less a rewrite of the client lib using more modern tooling and a code-generation-first approach to minimize the maintenance required to keep it in-sync with the dialpad API spec. It still uses requests, and the client interface is similar. It's not identical -- and it no longer supports py2, hence rolling the major version to 3.

jakedialpad added 30 commits June 12, 2025 13:04
@jakedialpad
Adds minimal working conversion to py3-only and uv-managed
870de26
@jakedialpad
Uses up-to-date spec for unit test mocks
65b0a6a
@jakedialpad
Removes deprecated endpoints
d68e102
@jakedialpad
Adds a dev CLI tool stub
5a3ed2f
@jakedialpad
Adds annotation generation util methods and tests
fe0977d
@jakedialpad
Moves the openapi spec to a module fixture
32065b7
@jakedialpad
Adds description to annotation.py
4018e67
@jakedialpad
Adds a test for http_method_to_func_def as well as a simple stub for …
3eb0bb2 
…the method implementation
@jakedialpad
Adds a first draft implementation for the http method function signature
53b0409
@jakedialpad
Adds a docstring generation piece that gemini came up with
844a664
@jakedialpad
Adds a similar bit for resource class definitions
c7745a6
@jakedialpad
Adds a simple generator method and test for resource module definitions
4f9d6a0
@jakedialpad
Adds a simple generate-module cli command
abfa7ec
@jakedialpad
Adds copilot instructions
e812f29
@jakedialpad
Improves module generation command
aa27a7b
@jakedialpad
Updates the CLI gen tool to optionally take the API path via a CLI pa…
68ae416 
…rameter
@jakedialpad
Adds the current user-id API module result verbatim into client_gen_e…
fd051ee 
…xemplars
@jakedialpad
Moves test_client_gen into the client_gen_tests directory
40f4bd5
@jakedialpad
Beefs up the client gen exemplar test output
5e65597
@jakedialpad
Adds copilot instruction for early-return preference
44cc92f
@jakedialpad
Adds better pytest default flags
7c2d94e
@jakedialpad
Adds small desired behaviour change via the user ID resource exemplar
1daf75d
@jakedialpad
Adds workaround for copilot to read test output
e573d53
@jakedialpad
Adds appropriate method naming
691aa7a
@jakedialpad
More instruction nuance
66bb830
@jakedialpad
Adds schema class generation
998e961
@jakedialpad
Makes pytest defaults include locals in the stack trace
db0fae2
@jakedialpad
Adds schema module generation and completeness test
e82c6d9
@jakedialpad
Adds CLI command to generate schema modules
9c6e184
@jakedialpad
Fix annotation order mistake
a6e4167
jakedialpad added 19 commits June 12, 2025 13:05
@jakedialpad
Bug fix
8bb5706
@jakedialpad
Updates resource module gen to include inner-type import for collecti…
f352b8e 
…on responses
@jakedialpad
Fixes path f-string bug
7cf6589
@jakedialpad
Properly unwraps NotRequired types
663e514
@jakedialpad
Adds support for Optional and Union as well
d9ac36b
@jakedialpad
Handle inner list types as well
a2d68a9
@jakedialpad
Burns out most test issues
10b8349
@jakedialpad
Updates schema module class definition order to be deterministic
c4d400d
@jakedialpad
Formatting fix
6c84433
@jakedialpad
Remove wfm bits (for now)
7e5dbba
@jakedialpad
Fixes unused imports and whatnot
64176b6
@jakedialpad
Formatting and linting fixes
81a9d00
@jakedialpad
Adds pagination handling test
85fb60a
@jakedialpad
Removes superfluous commands from cli
427f726
@jakedialpad
Updates the readme per the new tooling and processes and whatnot
2a370f9
@jakedialpad
Adds code coverage back in
f56256b
@jakedialpad
Fixes the b64 special-case
0ae3d24
@jakedialpad
Fixes the number swap issue (mostly)
ea42ffb
@jakedialpad
Fixes the ambiguous schema validation issue as well (and reformats so…
f6c2cee 
…me stuff)
@jakedialpad jakedialpad marked this pull request as ready for review June 12, 2025 20:42
@jakedialpad
Copy link
Collaborator Author

jakedialpad commented Jun 12, 2025

I'm just gonna go ahead and merge this in. The next steps will be:

  • build/publish automation via GHA
  • single interactive CLI command for pulling in the latest spec, regenerating the client, and publishing the new version
  • add an async client

@jakedialpad jakedialpad merged commit 7f6fbb9 into master Jun 12, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jakedialpad