yaningo / circleci.py Goto Github PK

Note: This project is no longer actively maintained. There is an active fork here.

Python Wrapper and SDK around the CircleCI API

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

1. Supports the latest v1.1 of the CircleCI API.
2. Supports both circleci.com and CircleCI server (aka "Enterprise").

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

pip install circleci

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

• You can read the general documentation for more information about using circleci.py.
• If you are interesting in hacking on this library, check out the developer documentation.

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

MIT

Lev Lazinskiy - https://levlaz.org