Async Python client for CircleCI API
Project description
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
- Fork it
- Install poetry (
pip install poetry
) - Install dependencies (
poetry install
) - Create your feature branch (
git checkout -b my-new-feature
) - Make sure
flake8
and thepytest
test suite successfully run locally - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pycircleci_async-0.1.1.tar.gz
(12.7 kB
view hashes)
Built Distribution
Close
Hashes for pycircleci_async-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33271a5eecfd315375d5e4907a02e459592dcbc6889fac7c8b90d38c5c4826c1 |
|
MD5 | cc83cc8ccfdf8e3b69f60f8d09552ba1 |
|
BLAKE2b-256 | a51e82927c7855238c24d8483b3de4ef30aa3ea215b9f64daa601e2abcc435bc |