alpinweis / pycircleci Goto Github PK

To support using this module with "on-prem" instances of CircleCI.

If you're interested in moving to f-strings now that we've dropped support for old Python versions, let me know. I have it basically working.

https://circleci.com/docs/api/v2/#tag/Job

• get_job_details(job_number, project_slug)

The rest on this page are already implemented using v1 endpoints

We should add some support for working with contexts

See docs starting around
https://circleci.com/docs/api/v2/#operation/listContexts

Basic auth seems to be disabled on my enterprise instance, would it be possible to support both types of auth?

For many important calls the API returns a { "items": [ ... ], "next_page_token": "string" } response. You need to use the next_page_token to get all the responses, but currently there is both no support from pycircleci to abstract this or a way to call your desired function with new next_page_token. So, one of the following improvements would be desirable:

• Abstract away all pagination such that pycircleci gets all pages for a response and returns the combined items. Although this might not be desired from some people who want to implement their own pagination logic as they don't want all items
• Add a next_page_token parameter to relevant pycircleci methods so that the user can call the function again to get the next page. Although some people would prefer if the library handled this for them so they don't need to write wrappers for all these pycircleci methods.

type hinting checks are now common practice, and adding a stubs file (.pyi) that defines the public interfaces is good practice.

many thanks!