{"id":13589869,"url":"https://github.com/alpinweis/pycircleci","last_synced_at":"2025-04-08T09:34:39.411Z","repository":{"id":39742516,"uuid":"241302627","full_name":"alpinweis/pycircleci","owner":"alpinweis","description":"Python client for CircleCI API","archived":false,"fork":false,"pushed_at":"2023-08-20T05:59:10.000Z","size":87,"stargazers_count":39,"open_issues_count":1,"forks_count":13,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-01T20:51:43.587Z","etag":null,"topics":["api","api-client","circleci","python"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alpinweis.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-02-18T07:51:56.000Z","updated_at":"2024-07-18T17:33:52.000Z","dependencies_parsed_at":"2024-01-16T21:58:47.629Z","dependency_job_id":"ce1a3d1c-7bd1-4173-92b6-2000925348f6","html_url":"https://github.com/alpinweis/pycircleci","commit_stats":{"total_commits":33,"total_committers":7,"mean_commits":4.714285714285714,"dds":0.5454545454545454,"last_synced_commit":"a634c783fe76c4a6fae4bf167456730bf093d8e3"},"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpinweis%2Fpycircleci","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpinweis%2Fpycircleci/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpinweis%2Fpycircleci/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alpinweis%2Fpycircleci/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alpinweis","download_url":"https://codeload.github.com/alpinweis/pycircleci/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223314456,"owners_count":17125089,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","circleci","python"],"created_at":"2024-08-01T16:00:35.588Z","updated_at":"2024-11-06T09:31:47.866Z","avatar_url":"https://github.com/alpinweis.png","language":"Python","funding_links":[],"categories":["python"],"sub_categories":[],"readme":"# pycircleci\n\n[![PyPI version](https://img.shields.io/pypi/v/pycircleci?color=blue)](https://python.org/pypi/pycircleci)\n[![Build Status](https://github.com/alpinweis/pycircleci/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/alpinweis/pycircleci/actions/workflows/test.yml?query=branch%3Amaster)\n\nPython client for [CircleCI API](https://circleci.com/docs/2.0/api-intro/).\n\nBased on the discontinued [circleci.py](https://github.com/levlaz/circleci.py) project.\n\n## Features\n\n- Supports [API v1.1](https://circleci.com/docs/api/#api-overview) and [API v2](https://circleci.com/docs/api/v2/)\n- Supports both `circleci.com` and self-hosted [Enterprise CircleCI](https://circleci.com/enterprise/)\n\n## Installation\n\n    $ pip install pycircleci\n\n## Usage\n\nCreate a personal [API token](https://circleci.com/docs/2.0/managing-api-tokens/#creating-a-personal-api-token).\n\nSet up the expected env vars:\n\n    CIRCLE_TOKEN           # CircleCI API access token\n    CIRCLE_API_URL         # CircleCI API base url. Defaults to https://circleci.com/api\n\n```python\nfrom pycircleci.api import Api, CIRCLE_TOKEN, CIRCLE_API_URL\n\ncircle_client = Api(token=CIRCLE_TOKEN, url=CIRCLE_API_URL)\n\n# get current user info\ncircle_client.get_user_info()\n\n# get list of projects\nresults = circle_client.get_projects()\n\n# pretty print results as json\ncircle_client.ppj(results)\n\n# pretty print the details of the last request/response\ncircle_client.ppr()\n```\n\n### Interactive development console\n\n     make console\n\nThis starts a pre-configured python interactive console which gives you access to a\n`client` object - an instance of the `Api` class to play around. From the console\ntype `man()` to see the help screen.\n\n### Contributing\n\n1. Fork it\n1. Install dev dependencies (`pip install -r requirements-dev.txt`)\n1. Create your feature branch (`git checkout -b my-new-feature`)\n1. Make sure `flake8` and the `pytest` test suite successfully run locally\n1. Commit your changes (`git commit -am 'Add some feature'`)\n1. Push to the branch (`git push origin my-new-feature`)\n1. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpinweis%2Fpycircleci","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falpinweis%2Fpycircleci","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falpinweis%2Fpycircleci/lists"}