pycircleci
Python client for CircleCI API.
Based on the discontinued circleci.py project.
Features
- Supports API v1.1 and API v2
- Supports both
circleci.comand self-hosted Enterprise CircleCI
Installation
$ pip install pycircleci
Usage
Create a personal API token.
Set up the expected env vars:
CIRCLE_TOKEN # CircleCI API access token
CIRCLE_API_URL # CircleCI API base url. Defaults to https://circleci.com/api
from pycircleci.api import Api, CIRCLE_TOKEN, CIRCLE_API_URL
circle_client = Api(token=CIRCLE_TOKEN, url=CIRCLE_API_URL)
# get current user info
circle_client.get_user_info()
# get list of projects
results = circle_client.get_projects()
# pretty print results as json
circle_client.ppj(results)
# pretty print the details of the last request/response
circle_client.ppr()
Interactive development console
make console
This starts a pre-configured python interactive console which gives you access to a
client object - an instance of the Api class to play around. From the console
type man() to see the help screen.
Contributing
- Fork it
- Install dev dependencies (
pip install -r requirements-dev.txt) - Create your feature branch (
git checkout -b my-new-feature) - Make sure
flake8and thepytesttest suite successfully run locally - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
1 maintainer
Metadata
1 maintainer
Release files for pycircleci 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pycircleci-0.7.0.tar.gz | 15.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pycircleci-0.7.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 30.9 kB
Release files / pycircleci-0.7.0.tar.gz
| Download URL | pycircleci-0.7.0.tar.gz |
|---|---|
| Size | 15.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4153069b2e607693997e4ffe7a0a806e489ffe14e4cff67c1a7e954f0b3b397b
|
|
BLAKE2b-256 checksum How to use checksums |
3e67a4130f7122b1a82b31bda2edacbfdf47d7e4417d6d6f96e7e772d9b54af9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.16
|
Release files / pycircleci-0.7.0-py3-none-any.whl
| Download URL | pycircleci-0.7.0-py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f2835174324e95346829e5824072e4cf2d81460c2a370a422718d95b99a7bdc1
|
|
BLAKE2b-256 checksum How to use checksums |
24ea5dd6df1443c594ca2677c18812bc9f7993905705559231337e4391d307f1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.10.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.16
|
