An open API service indexing awesome lists of open source software.

https://github.com/josh/gh-audit

Personal GitHub repository meta linting tool for consistent configuration
https://github.com/josh/gh-audit

linter python

Last synced: 11 months ago
JSON representation

Personal GitHub repository meta linting tool for consistent configuration

Awesome Lists containing this project

README

          

# gh-audit

Personal GitHub repository meta linting tool for consistent configuration. Probably not interesting to you.

## Installation

```sh
$ pip install git+https://github.com/josh/gh-audit.git
```

## Usage

```sh
$ gh-audit --help
Usage: gh-audit [OPTIONS] [REPOSITORY]...

Options:
--active Include all your non-archived repositories
--github-token TOKEN GitHub API token [required]
--verbose Enable debug logging
--rule RULE Specify rules to run
--format [repo|rule] [required]
--version Show the version and exit.
--help Show this message and exit.
```

## Development

To contribute to this tool, first checkout the code. Then create a new virtual environment:

```sh
cd gh-audit
uv venv
source .venv/bin/activate
```

Now install the dependencies and test dependencies:

```sh
uv sync
```