Skip to main content

Python client for CircleCI API

Project description


PyPI version Build Status

Python client for CircleCI API.

Based on the discontinued project.



$ 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
from pycircleci.api import Api, CIRCLE_TOKEN, CIRCLE_API_URL

circle_client = Api(token=CIRCLE_TOKEN, url=CIRCLE_API_URL)

# get current user info

# get list of projects
results = circle_client.get_projects()

# pretty print results as json

# pretty print the details of the last request/response

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.


  1. Fork it
  2. Install dev dependencies (pip install -r requirements-dev.txt)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Make sure flake8 and the pytest test suite successfully run locally
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycircleci-0.7.0.tar.gz (15.5 kB view hashes)

Uploaded Source

Built Distribution

pycircleci-0.7.0-py3-none-any.whl (15.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page