Skip to main content

Python wrapper for the CircleCI API

Project description

circleci.py

Python Wrapper around the CircleCI API

CI Status Code Coverage PyPi PAckage Documentation Status

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()

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

circleci-1.1.2.tar.gz (7.5 kB view hashes)

Uploaded Source

Built Distribution

circleci-1.1.2-py3-none-any.whl (7.6 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