GitHub REST API

Installation

Install using pip:

pip install github-rest-cli

Install using uv:

uv pip install github-rest-cli

Usage

Set up python package dependencies in pyproject.toml:

uv sync

After sync the project, activate virtualenv in .venv directory:

source .venv/bin/activate

To list all installed packages, run:

uv pip list

Export your GitHub PAT as environment variable:

export GITHUB_AUTH_TOKEN="<github-auth-token>"

Run cli:

github-rest-cli -v

Dynaconf

This python cli app uses dynaconf to manage secrets and environment variables.

So that you can use your secrets and environment variables declared in settings.toml or .settings.toml, use the GITHUB prefix value of envvar_prefix declared in config.py.

List all defined parameters:

just dl

Validate all defined parameters:

just dv

NOTE: To run dynaconf validate dynaconf_validators.toml should exist.

Ruff

Run lint:

just lint

Run format:

just fmt