Python client for CircleCI API
Python client for CircleCI API.
Based on the discontinued circleci.py project.
circleci.com
and self-hosted Enterprise CircleCI
$ pip install pycircleci
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()
make console
This starts a pre-configured python interactive console which gives you access to aclient
object - an instance of the Api
class to play around. From the console
type man()
to see the help screen.
pip install -r requirements-dev.txt
)git checkout -b my-new-feature
)flake8
and the pytest
test suite successfully run locallygit commit -am 'Add some feature'
)git push origin my-new-feature
)