Welcome to circleci.py

circleci.py is a python wrapper around the CircleCI API.

The source code for circleci.py can be found on GitHub.

Quickstart

• Quickstart
  • Installation
  • Basic Usage

Tutorial

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • API Object
  • Errors

Utilities

Refernce for various utility modules in circleci.py

• Utilities
  • version module

Developer Documentation

• Developer Documentation
  • Installing Development Environment
  • Running Tests
  • Documentation
  • Linting and Style

Changelog

• Changelog
  • Version 2.0.0
  • Version 1.2.2
  • Version 1.1.3
  • Version 1.1.2
  • Version 1.1.1
  • Version 1.1.0

Attribution

• circleci.py relies on the wonderful requests library for all HTTP requests. This library is licensed under the Apache License, Version 2.0.
• A majority of the API doc strings are adapted from the official CircleCI API documentation which is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.