Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Python Publish Release
run-name: Publish
on:
release:
types:
- created

jobs:
release:
name: Publish to PyPI
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up uv
uses: astral-sh/setup-uv@v6

- name: Build
run: uv build

- name: Publish
run: uv publish
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# GitHub REST API

### Use

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.
### Usage

Set up python package dependencies in `pyproject.toml`:
```shell
Expand All @@ -21,20 +17,23 @@ To list all installed packages, run:
uv pip list
```

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

Run the `github-rest-api` cli:
Run cli:
```shell
github-rest-api -h
github-rest-cli -h
```

### Dynaconf

List all defined parameters:
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
```
Expand Down