pycircleci-async

pycircleci

Asynchronous Python client for CircleCI API.

Ported from pycircleci, a fork of the discontinued circleci.py project.

Features

• Supports API v1.1 and API v2
• Supports both circleci.com and self-hosted Enterprise CircleCI

Installation

$ pip install pycircleci-async

Usage

Create a personal API token.

Set up the expected env vars:

CIRCLE_TOKEN           # CircleCI API access token
CIRCLE_API_URL         # CircleCI API base url. Defaults to https://circleci.com/api

import asyncio
from pycircleci_async import CircleCIClient


async def main():
    async with CircleCIClient(token='<access-token-uuid>') as circle_client:
        # get current user info
        await circle_client.get_user_info()

        # get list of projects
        results = await circle_client.get_projects()


asyncio.run(main())

Contributing

1. Fork it
2. Install poetry (pip install poetry)
3. Install dependencies (poetry install)
4. Create your feature branch (git checkout -b my-new-feature)
5. Make sure flake8 and the pytest test suite successfully run locally
6. Commit your changes (git commit -am 'Add some feature')
7. Push to the branch (git push origin my-new-feature)
8. Create new Pull Request