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 562d2b6..2f35182 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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="" 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: +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 ```