From fcdbbf0562061a9c1391b13cfa785ec836f35677 Mon Sep 17 00:00:00 2001 From: lbrealdev Date: Wed, 28 May 2025 09:47:30 +0200 Subject: [PATCH 1/2] docs: update README.md --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 562d2b6..df82026 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub REST API -### Use +### Usage This python cli app uses dynaconf to manage secrets and environment variables. @@ -21,20 +21,19 @@ To list all installed packages, run: uv pip list ``` -Export required environment variables: +Export your **GitHub PAT** as environment variable: ```shell -export GITHUB_USER="" export 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: +List all defined parameters: ```shell just dl ``` From d0c951ceadd88674258af0ceea9973d31c5dff0e Mon Sep 17 00:00:00 2001 From: lbrealdev Date: Wed, 28 May 2025 10:03:06 +0200 Subject: [PATCH 2/2] feat(actions): add release.yml --- .github/workflows/release.yml | 24 ++++++++++++++++++++++++ README.md | 8 ++++---- 2 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..eff9293 --- /dev/null +++ b/.github/workflows/release.yml @@ -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 diff --git a/README.md b/README.md index df82026..2f35182 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,6 @@ ### Usage -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. - Set up python package dependencies in `pyproject.toml`: ```shell uv sync @@ -33,6 +29,10 @@ github-rest-cli -h ### 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