https://github.com/aleksac/circleci-cli-py

pip installable CircleCI CLI binary
https://github.com/aleksac/circleci-cli-py

circleci pre-commit pre-commit-hook

Last synced: 5 days ago
JSON representation

pip installable CircleCI CLI binary

• Host: GitHub
• URL: https://github.com/aleksac/circleci-cli-py
• Owner: AleksaC
• License: mit
• Created: 2020-08-20T23:49:25.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-08-23T12:09:14.000Z (3 months ago)
• Last Synced: 2024-08-23T13:34:10.319Z (3 months ago)
• Topics: circleci, pre-commit, pre-commit-hook
• Language: Python
• Homepage:
• Size: 149 KB
• Stars: 4
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# circleci-cli-py

[![License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

[![Run tests](https://github.com/AleksaC/circleci-cli-py/actions/workflows/tests.yml/badge.svg)](https://github.com/AleksaC/circleci-cli-py/actions/workflows/tests.yml)

[![Autoupdater Status](https://circleci.com/gh/AleksaC/circleci-cli-py.svg?style=svg)](https://circleci.com/gh/AleksaC/circleci-cli-py)

A python package that provides a pip-installable

[CircleCI CLI](https://github.com/CircleCI-Public/circleci-cli) binary.

The mechanism by which the binary is downloaded is basically copied from

[shellcheck-py](https://github.com/shellcheck-py/shellcheck-py).

## Getting started

### Installation

The package hasn't been published to PyPI yet, and may never be, as its primary

purpose doesn't require it. However you can install it through git:

```shell script

pip install git+git://github.com/AleksaC/[email protected]

```

### With pre-commit

This package was primarily built to provide a convenient way of running hadolint

as a [pre-commit](https://pre-commit.com) hook, since pre-commit seems unable to

install it as a golang hook.

Example `.pre-commit-config.yaml`:

```yaml

repos:

  - repo: https://github.com/AleksaC/circleci-cli-py

    rev: v0.1.30995

    hooks:

      - id: circle-ci-validator

```

## Contact 🙋‍♂️

- [Personal website](https://aleksac.me)

- 

- [email protected]