This replaces the previous implementation of manually calling encoding query params with urlencode with requests.get(url, params=params, ...).

This moves the responsibility of encoding the query parameters to the requests library.

Less responsibility is usually better! ;)

Pipelines, Builds, Jobs, and Agents are all currently only using GET endpoints. We need full CRUD ability, adding POST, PUT, and DELETE functionality to these to make them feature complete would be great. Doesn't have to be all in one PR.

Summary

This adds team_uuids optional parameter to create_yaml_pipeline. For our organisation, teams are mandatory for pipeline creation, and when omitted will result in:

{"message":"Validation Failed","errors":[{"field":"teams","code":"Please ensure at least one team is added to this pipeline","value":[]}]}

This changes the way artifacts are downloaded:

• Always returns bytes, not unicode text or parsed Json
• Can return iterator of bytes chunks to stream artifact over HTTP

Artifacts can be of arbitrary mime type, but currently they are always parsed as JSON, which fails for everything but JSON artifacts. Artifacts should be downloaded as bytes, where user code can than treat those bytes as desired, e.g.: json.loads(str(the_bytes)).

The client.get method currently only returns either parsed JSON or unicode text, so this has to be touched as well. Encoding the retrieved bytes as unicode as a default for any non application/json mime type is quite a hard assumption, and even if type is text/* this could be encode in so many other ways. Again, user code can easily decode the bytes as required. So I think bytes is a good default return type for client.get if Accept is something other than application/json.

Finally, since requests supports HTTP streaming, the artifact content can easily be streamed to user code as well (e.g. to write that to disk). With streaming, memory footprint stays low and independent of the size of the downloaded artifact.

Artifact content can be consumed like:

If artifact is unicode:

    artifact = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact")
    str(artifact)

If artifact is json:

    artifact = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact")
    json.loads(str(artifact))

Byte content of artifact:

    artifact = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact")
    with open('artifact.bin', 'b') as f:
      f.write(artifact)

Streaming artifact:

    artifact = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact", as_stream=True)
    with open('artifact.bin', 'b') as f:
      for chunk in artifact:
        f.write(chunk)

Create a new file and class to incorporate the meta API.

• Create a new file called meta.py
• Create a class called Meta
• Return the Meta class from a method in buildkite.py
• Write unit tests for the new code

Fixes several errors in Jobs class, in base_url, log, env, and fields for unblock. E.g., 500 Server Error: Internal Server Error for url: https://api.buildkite.com/v2//organizations/...

Hi, I am trying to load all our builds via buildkite.builds().list_all This returns the first 100 results (as expected) but I can't figure out if there is a way to get the next 100 results.

Create a new file and class to incorporate the Access Token API

• Create a new file called access_token.py
• Create a class called AccessToken
• Return the AccessToken class from a method in buildkite.py
• Write unit tests for the new code

The API provides support for updating a pipeline via PATCH: https://buildkite.com/docs/apis/rest-api/pipelines#update-a-pipeline

This doesn't seem to be supported by the library yet (the base client also doesn't provide a PATCH method, so the only way to update a pipeline currently is using the rest API directly as far as I can tell).

Due to following line the state query param looks like passed instead of state=passed

https://github.com/pyasi/pybuildkite/blob/59db85d18aed949970507b3af8f1fb30b1a18e52/pybuildkite/builds.py#L316

pls add: state=+

It would be great if a new release could be issued, as I'm looking forward to using this improvement :pray: https://github.com/pyasi/pybuildkite/pull/82

My best attempt at partly addressing https://github.com/pyasi/pybuildkite/issues/48. This types all functions in pybuildkite/.

I did this manually, so there might be some slightly incorrect types. Also, there are at least 3 # TODO: Bad Any. I most didn't feel like addressing. Sorry.

Also, this will most likely conflict with https://github.com/pyasi/pybuildkite/pull/80.

Adds support for https://buildkite.com/docs/apis/agent-api/metrics.

This API is somewhat different from the rest considering is use the agent token rather than the access token.

Let me know if the high-level looks good and I can include some tests as well.

Also, closes https://github.com/pyasi/pybuildkite/issues/72

The create_yaml_pipeline method is missing many parameters listed at https://buildkite.com/docs/apis/rest-api/pipelines#create-a-yaml-pipeline. These all need to be added. Alternatively, I would actually recommend just accepting kwargs for all parameters that don't need any further formatting. Then the Python package can be robust to changes to the Buildkite API with minimal maintenance. This comes at the cost of a more self-documenting Python API, but given the lack of activity on this repo I think it would be better to just point to the Buildkite documentation as the source of truth.

Create a method for the Add a Webhook functionality

• Create a new method in pipelines.py to use the endpoint described above
• Write unit tests for the new code

Create methods for the Archive and Unarchive functionality

• Create new methods in pipelines.py to use the endpoints described above
• Write unit tests for the new code