Metadata-Version: 2.4
Name: github-rest-cli
Version: 1.0.2
Summary: GitHub REST API cli
Author-email: lbrealdev <lbrealdeveloper@gmail.com>
License-File: LICENSE
Requires-Python: >=3.11
Requires-Dist: dynaconf>=3.2.11
Requires-Dist: requests>=2.31.0
Requires-Dist: rich>=14.0.0
Description-Content-Type: text/markdown

# GitHub REST API

## Installation

Install using `pip`:
```shell
pip install github-rest-cli
```

Install using `uv`:
```shell
uv pip install github-rest-cli
```

## Usage

Set up python package dependencies in `pyproject.toml`:
```shell
uv sync
```

After sync the project, activate virtualenv in `.venv` directory:
```shell
source .venv/bin/activate
```

To list all installed packages, run:
```shell
uv pip list
```

Export your **GitHub PAT** as environment variable:
```shell
export GITHUB_AUTH_TOKEN="<github-auth-token>"
```

Run cli:
```shell
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:
```shell
just dl
```

Validate all defined parameters:
```shell
just dv
```

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

### Ruff

Run lint:
```shell
just lint
```

Run format:
```shell
just fmt
```
