Skip to main content

githubtemplateastraluv/templateastraluv (0.0.2)

Python 3.11+ License: GPL-3.0 Platforms Docs uv

GitHub template for Astral-UV apps published on PyPI.
Python CLI template with Astral uv/uvx packaging, PyPI OIDC Trusted Publishing release automation, self-upgrade from PyPI (or the latest GitHub tag via --develop), and a dual-source version report.

Quick Start | Feature Highlights | Acknowledgments


🚧 DRAFT: 👾 Alpha Development 👾 - Work in Progress 🏗️ 🚧
⚠️ IMPORTANT NOTICE: Created with useReq/req 🤖✨ ⚠️

Feature Highlights

  • Published on PyPI: install with uv tool install githubtemplateastraluv.
  • Automatic online new-version check (PyPI) throttled by an idle-time cache.
  • --ver dual-source report: installed, latest PyPI, and latest GitHub versions, with aligned columns.
  • Self-upgrade from PyPI; --upgrade --develop pulls the latest GitHub tagged release; --upgrade --force forces full re-download and reinstallation.
  • Colored console notifications with user-configurable colors.
  • Release automation: GitHub release for every version tag; OIDC Trusted Publishing to PyPI for master tags only.

Quick Start

  1. Install the tool from PyPI:
uv tool install githubtemplateastraluv
  1. Run it:
githubtemplateastraluv --help

Usage

# Print the version report (aligned columns)
githubtemplateastraluv --ver

Output format:

Current Installed : X1.Y1.Z1
Latest @ PyPI     : X2.Y2.Z2
Latest @ GitHub   : X3.Y3.Z3
# Upgrade from PyPI (Linux; prints the manual command elsewhere)
githubtemplateastraluv --upgrade

# Force full re-download and reinstallation from PyPI
githubtemplateastraluv --upgrade --force

# Upgrade to the latest GitHub tagged release (any branch)
githubtemplateastraluv --upgrade --develop

# Force full re-download and reinstallation from GitHub
githubtemplateastraluv --upgrade --develop --force

# Uninstall (Linux; prints the manual command elsewhere)
githubtemplateastraluv --uninstall

# Full help screen
githubtemplateastraluv --help

Install with Astral uv (PyPI — primary method)

Install

uv tool install githubtemplateastraluv

Upgrade

githubtemplateastraluv --upgrade

Uninstall

uv tool uninstall githubtemplateastraluv

Live execution with uvx (alternative method)

Run githubtemplateastraluv directly from PyPI without prior installation:

uvx githubtemplateastraluv

You can pass options as usual, for example:

uvx githubtemplateastraluv <args>

Install and upgrade from GitHub (development releases)

A dedicated, non-primary distribution channel hosts intermediate and test releases on GitHub: https://github.com/Ogekuri/GitHub-Template-AstralUV.

Install

uv tool install githubtemplateastraluv --force --from git+https://github.com/Ogekuri/GitHub-Template-AstralUV.git

Upgrade to the latest GitHub tagged release (any branch)

githubtemplateastraluv --upgrade --develop

Force full re-download and reinstallation

githubtemplateastraluv --upgrade --force
githubtemplateastraluv --upgrade --develop --force

--upgrade --develop always downloads the most recent tagged build from GitHub, regardless of the branch it was tagged on (master, develop, or any other branch). The --ver report shows the GitHub latest release in the Latest @ GitHub row.



## Repository Tooling Scripts

| Script | Purpose |
| --- | --- |
| `scripts/templateastraluv.sh` | Local-run launcher delegating to `uv run --project <root> python -m githubtemplateastraluv`. |
| `scripts/build.sh` | Release packager: cleans the generated state, removes stale `dist/*.tar.gz`/`dist/*.whl`, builds `uv run --frozen --with build python -m build`, and verifies the produced sdist and wheel. |
| `scripts/clean.sh` | Removes every repository-internal execution-generated artifact and restores the canonical startup state. |
| `scripts/pre-release-check.sh` | Fail-fast release verification (syntax, compileall, pytest, out-of-tree build, artifact validation) with baseline-guarded cleanup. |

`scripts/clean.sh` removes `__pycache__/` and `*.egg-info/` at any depth,
the `.pytest_cache/`, `.ruff_cache/`, `.mypy_cache/`, `build/`, and
`.venv/` directories, and the `.coverage`/`.coverage.*` data files. It is
idempotent (absent targets are a successful no-op), never touches tracked
files, untracked user files, `$HOME` application data, or the versioned
release artifacts in `dist/`, and never runs destructive git commands.
`scripts/build.sh` delegates its pre-build cleanup to `scripts/clean.sh`,
so two consecutive builds always start from the identical state:

```bash
# Remove all execution-generated temporary artifacts
./scripts/clean.sh

# Build from the canonical cleaned state (also via clean.sh)
./scripts/build.sh

Acknowledgments

TODO: fill scknowledgments section

Metadata

Release files for githubtemplateastraluv 0.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for githubtemplateastraluv 0.0.2
File Size Uploaded Provenance Actions
githubtemplateastraluv-0.0.2.tar.gz 48.8 kB With provenance Details for githubtemplateastraluv-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for githubtemplateastraluv 0.0.2
File Interpreter ABI Platform Actions
githubtemplateastraluv-0.0.2-py3-none-any.whl Python 3 none any Details for githubtemplateastraluv-0.0.2-py3-none-any.whl

Total release size: 87.9 kB

Release files / githubtemplateastraluv-0.0.2.tar.gz

Download URL githubtemplateastraluv-0.0.2.tar.gz
Size 48.8 kB
Tags Source
SHA-256 checksum
How to use checksums
8fac9cd9336d063a34f01bdfad801fbfbfab7676eb41953a12c14a347f0e24ec
BLAKE2b-256 checksum
How to use checksums
31149577b64f2599791d5b53b670f59b17af87a1da8093393a2131536b3d7472
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Release files / githubtemplateastraluv-0.0.2-py3-none-any.whl

Download URL githubtemplateastraluv-0.0.2-py3-none-any.whl
Size 39.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3cca0e7f218bfad9c45ed10a475b38fd662102d6d117f0948229ea3c5a2525ed
BLAKE2b-256 checksum
How to use checksums
5c6859d3e1e26a9480c6d66b94172370f1dc3a5a65063ce10678ad515aac72c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

Security for githubtemplateastraluv 0.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for githubtemplateastraluv-0.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page