Skip to main content

Python wrapper for the CircleCI API

Project description

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

Project details


Download files

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

Files for circleci, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size circleci-1.2.2-py3-none-any.whl (10.6 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size circleci-1.2.2.tar.gz (9.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page