| Name | pybuildkite JSON |
| Version |
1.2.4
JSON |
| download |
| home_page | https://github.com/pyasi/pybuildkite |
| Summary | Python wrapper for the Buildkite API |
| upload_time | 2024-10-04 17:39:29 |
| maintainer | None |
| docs_url | None |
| author | Peter Yasi |
| requires_python | None |
| license | BSD 2-Clause License Copyright (c) 2019, Peter Yasi All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
buildkite
continuous integration
api
ci
wrapper
python
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PyBuildkite
[](https://buildkite.com/pybuildkite/pybuildkite)
[](https://coveralls.io/github/pyasi/pybuildkite?branch=master)
[](https://pypi.org/project/pybuildkite/)
[](https://pypi.org/project/pybuildkite/)
A [Python](https://www.python.org/) library and client for the [Buildkite API](https://buildkite.com/docs/api).
## Usage
To get the package, execute:
```
pip install pybuildkite
```
Then set up an instance of the Buildkite object, set you access token, and make any available requests.
```python
from pybuildkite.buildkite import Buildkite, BuildState
buildkite = Buildkite()
buildkite.set_access_token('YOUR_API_ACCESS_TOKEN_HERE')
# Get all info about particular org
org = buildkite.organizations().get_org('my-org')
# Get all running and scheduled builds for a particular pipeline
builds = buildkite.builds().list_all_for_pipeline('my-org', 'my-pipeline', states=[BuildState.RUNNING, BuildState.SCHEDULED])
# Create a build
buildkite.builds().create_build('my-org', 'my-pipeline', 'COMMITSHA', 'master',
clean_checkout=True, message="My First Build!")
```
## Pagination
Buildkite offers pagination for endpoints that return a lot of data. By default this wrapper return `100` objects. However, any request that may contain more than that offers a pagination option.
When `with_pagination=True`, we return a response object with properties that may have `next_page`, `last_page`, `previous_page`, or `first_page` depending on what page you're on.
```python
builds_response = buildkite.builds().list_all(page=1, with_pagination=True)
# Keep looping until next_page is not populated
while builds_response.next_page:
builds_response = buildkite.builds().list_all(page=builds_response.next_page, with_pagination=True)
```
## Artifacts
Artifacts can be downloaded as binary data. The following example loads the artifact into memory as
[Python bytes](https://docs.python.org/3/library/stdtypes.html#binary-sequence-types-bytes-bytearray-memoryview)
and then writes them to disc:
```python
artifacts = buildkite.artifacts()
artifact = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact")
with open('artifact.bin', 'b') as f:
f.write(artifact)
```
Large artifacts should be streamed as chunks of bytes to limit the memory consumption:
```python
stream = artifacts.download_artifact("org_slug", "pipe_slug", "build_no", 123, "artifact", as_stream=True)
with open('artifact.bin', 'b') as f:
for chunk in stream:
f.write(chunk)
```
A unicode text artifact can be turned into a string easily:
```python
text = str(artifact)
```
## License
This library is distributed under the BSD-style license found in the LICENSE file.
Raw data
{
"_id": null,
"home_page": "https://github.com/pyasi/pybuildkite",
"name": "pybuildkite",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Buildkite, Continuous Integration, API, CI, wrapper, python",
"author": "Peter Yasi",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/a8/d5/6c9003e5e71b7ffb49c9a94eaa146c7854bd0af7e65a4baea7e859ca9505/pybuildkite-1.2.4.tar.gz",
"platform": null,
"description": "# PyBuildkite\n\n[](https://buildkite.com/pybuildkite/pybuildkite)\n[](https://coveralls.io/github/pyasi/pybuildkite?branch=master)\n[](https://pypi.org/project/pybuildkite/)\n[](https://pypi.org/project/pybuildkite/)\n\nA [Python](https://www.python.org/) library and client for the [Buildkite API](https://buildkite.com/docs/api).\n\n## Usage\n\nTo get the package, execute:\n\n```\npip install pybuildkite\n```\n\nThen set up an instance of the Buildkite object, set you access token, and make any available requests.\n\n```python\nfrom pybuildkite.buildkite import Buildkite, BuildState\n\nbuildkite = Buildkite()\nbuildkite.set_access_token('YOUR_API_ACCESS_TOKEN_HERE')\n\n# Get all info about particular org\norg = buildkite.organizations().get_org('my-org')\n\n# Get all running and scheduled builds for a particular pipeline\nbuilds = buildkite.builds().list_all_for_pipeline('my-org', 'my-pipeline', states=[BuildState.RUNNING, BuildState.SCHEDULED])\n\n# Create a build\nbuildkite.builds().create_build('my-org', 'my-pipeline', 'COMMITSHA', 'master', \nclean_checkout=True, message=\"My First Build!\")\n```\n\n## Pagination\n\nBuildkite offers pagination for endpoints that return a lot of data. By default this wrapper return `100` objects. However, any request that may contain more than that offers a pagination option.\n\nWhen `with_pagination=True`, we return a response object with properties that may have `next_page`, `last_page`, `previous_page`, or `first_page` depending on what page you're on.\n\n```python\nbuilds_response = buildkite.builds().list_all(page=1, with_pagination=True)\n\n# Keep looping until next_page is not populated\nwhile builds_response.next_page:\n builds_response = buildkite.builds().list_all(page=builds_response.next_page, with_pagination=True)\n```\n\n## Artifacts\n\nArtifacts can be downloaded as binary data. The following example loads the artifact into memory as\n[Python bytes](https://docs.python.org/3/library/stdtypes.html#binary-sequence-types-bytes-bytearray-memoryview)\nand then writes them to disc:\n\n```python\nartifacts = buildkite.artifacts()\nartifact = artifacts.download_artifact(\"org_slug\", \"pipe_slug\", \"build_no\", 123, \"artifact\")\nwith open('artifact.bin', 'b') as f:\n f.write(artifact)\n```\n\nLarge artifacts should be streamed as chunks of bytes to limit the memory consumption:\n```python\nstream = artifacts.download_artifact(\"org_slug\", \"pipe_slug\", \"build_no\", 123, \"artifact\", as_stream=True)\nwith open('artifact.bin', 'b') as f:\n for chunk in stream:\n f.write(chunk)\n```\n\nA unicode text artifact can be turned into a string easily:\n```python\ntext = str(artifact)\n```\n\n## License\n\nThis library is distributed under the BSD-style license found in the LICENSE file.\n",
"bugtrack_url": null,
"license": "BSD 2-Clause License Copyright (c) 2019, Peter Yasi All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "Python wrapper for the Buildkite API",
"version": "1.2.4",
"project_urls": {
"Download": "https://github.com/pyasi/pybuildkite/archive/master.zip",
"Homepage": "https://github.com/pyasi/pybuildkite",
"Repository": "https://github.com/pyasi/pybuildkite.git"
},
"split_keywords": [
"buildkite",
" continuous integration",
" api",
" ci",
" wrapper",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "956f2aefa734c6ed775a2bf8311e6c6cc99cd00e1b4a6356bb1646219881e8ef",
"md5": "0b1573f276656c231aa6f199f2b677a7",
"sha256": "675f548fdbd58c356f5463323528dedaa3bff66414190fe2b8efa11f6123d7d0"
},
"downloads": -1,
"filename": "pybuildkite-1.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b1573f276656c231aa6f199f2b677a7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 18949,
"upload_time": "2024-10-04T17:39:28",
"upload_time_iso_8601": "2024-10-04T17:39:28.028948Z",
"url": "https://files.pythonhosted.org/packages/95/6f/2aefa734c6ed775a2bf8311e6c6cc99cd00e1b4a6356bb1646219881e8ef/pybuildkite-1.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8d56c9003e5e71b7ffb49c9a94eaa146c7854bd0af7e65a4baea7e859ca9505",
"md5": "5f2d37a585adcb402cfd7aa28c403e2b",
"sha256": "7c1fe9417b723035f757eee7a8749df351ad62da5372157f378b1fa99c0aa28c"
},
"downloads": -1,
"filename": "pybuildkite-1.2.4.tar.gz",
"has_sig": false,
"md5_digest": "5f2d37a585adcb402cfd7aa28c403e2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 20229,
"upload_time": "2024-10-04T17:39:29",
"upload_time_iso_8601": "2024-10-04T17:39:29.510232Z",
"url": "https://files.pythonhosted.org/packages/a8/d5/6c9003e5e71b7ffb49c9a94eaa146c7854bd0af7e65a4baea7e859ca9505/pybuildkite-1.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 17:39:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pyasi",
"github_project": "pybuildkite",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pybuildkite"
}
