Python wrapper for the CircleCI API


Keywords
circleci, ci, cd, api, sdk, python
License
MIT
Install
pip install circleci==1.2.2

Documentation

circleci.py

Python Wrapper and SDK around the CircleCI API

CI Status Code Coverage PyPi PAckage Documentation Status

Warnings

  • circleci.py does not yet fully support CircleCI 2.1 or the Workflows API

Features

  1. Supports the latest v1.1 of the CircleCI API.
  2. Supports both circleci.com and CircleCI server (aka "Enterprise").
  3. Experimental API endpoints using undocumented aspects of the API.

Installation

circleci.py requires Python 3. Python 2 will be EOL soon, it's time to make the switch.

pip install circleci

Quickstart

Make a new API token in the CircleCI application.

Import the CircleCI API and start using methods:

from circleci.api import Api

circleci = Api("$YOUR_TOKEN")

# get info about your user
circleci.get_user_info()

# get list of all of your projects
circleci.get_projects()

Real World Examples

Here are a couple of real world examples of this library being used. If you want to add your example here, open up a PR.

Contributing

Please create an issue with a description of your problem, or open a pull request with a fix.

License

MIT

Original Author

Lev Lazinskiy - https://levlaz.org