githubtemplateastraluv 0.0.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- githubtemplateastraluv/__init__.py +18 -0
- githubtemplateastraluv/__main__.py +15 -0
- githubtemplateastraluv/config.py +662 -0
- githubtemplateastraluv/config_render.py +474 -0
- githubtemplateastraluv/core.py +77 -0
- githubtemplateastraluv/management.py +247 -0
- githubtemplateastraluv/version_check.py +389 -0
- githubtemplateastraluv-0.0.2.dist-info/METADATA +196 -0
- githubtemplateastraluv-0.0.2.dist-info/RECORD +13 -0
- githubtemplateastraluv-0.0.2.dist-info/WHEEL +5 -0
- githubtemplateastraluv-0.0.2.dist-info/entry_points.txt +3 -0
- githubtemplateastraluv-0.0.2.dist-info/licenses/LICENSE +674 -0
- githubtemplateastraluv-0.0.2.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: githubtemplateastraluv
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: GitHub template for Astral-UV app.
|
|
5
|
+
Author: Francesco Rolando
|
|
6
|
+
License-Expression: GPL-3.0-only
|
|
7
|
+
Project-URL: Homepage, https://github.com/Ogekuri/GitHub-Template-AstralUV
|
|
8
|
+
Project-URL: Repository, https://github.com/Ogekuri/GitHub-Template-AstralUV
|
|
9
|
+
Keywords: shell,scripts,uv,astral,uvx,cli
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Topic :: Utilities
|
|
16
|
+
Requires-Python: >=3.11
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# githubtemplateastraluv/templateastraluv (0.0.2)
|
|
22
|
+
|
|
23
|
+
<p align="center">
|
|
24
|
+
<img src="https://img.shields.io/badge/python-3.11%2B-3776AB?style=flat-square&logo=python&logoColor=white" alt="Python 3.11+">
|
|
25
|
+
<img src="https://img.shields.io/badge/license-GPL--3.0-491?style=flat-square" alt="License: GPL-3.0">
|
|
26
|
+
<img src="https://img.shields.io/badge/platform-Linux-6A7EC2?style=flat-square&logo=terminal&logoColor=white" alt="Platforms">
|
|
27
|
+
<img src="https://img.shields.io/badge/docs-live-b31b1b" alt="Docs">
|
|
28
|
+
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json" alt="uv">
|
|
29
|
+
</p>
|
|
30
|
+
<p align="center">
|
|
31
|
+
<strong>GitHub template for Astral-UV apps published on PyPI.</strong><br>
|
|
32
|
+
Python CLI template with Astral uv/uvx packaging, PyPI OIDC Trusted
|
|
33
|
+
Publishing release automation, self-upgrade from PyPI (or the latest
|
|
34
|
+
GitHub tag via <code>--develop</code>), and a dual-source version report.
|
|
35
|
+
</p>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<p align="center">
|
|
39
|
+
<a href="#quick-start">Quick Start</a> |
|
|
40
|
+
<a href="#feature-highlights">Feature Highlights</a> |
|
|
41
|
+
<a href="#acknowledgments">Acknowledgments</a>
|
|
42
|
+
</p>
|
|
43
|
+
|
|
44
|
+
<p align="center">
|
|
45
|
+
<br>
|
|
46
|
+
🚧 <strong>DRAFT</strong>: 👾 Alpha Development 👾 - Work in Progress 🏗️ 🚧<br>
|
|
47
|
+
⚠️ <strong>IMPORTANT NOTICE</strong>: Created with <a href="https://github.com/ogekuri/useReq"><strong>useReq/req</strong></a> 🤖✨ ⚠️<br>
|
|
48
|
+
<br>
|
|
49
|
+
<p>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
## Feature Highlights
|
|
53
|
+
- Published on PyPI: install with `uv tool install githubtemplateastraluv`.
|
|
54
|
+
- Automatic online new-version check (PyPI) throttled by an idle-time cache.
|
|
55
|
+
- `--ver` dual-source report: installed, latest PyPI, and latest GitHub versions, with aligned columns.
|
|
56
|
+
- Self-upgrade from PyPI; `--upgrade --develop` pulls the latest GitHub tagged release; `--upgrade --force` forces full re-download and reinstallation.
|
|
57
|
+
- Colored console notifications with user-configurable colors.
|
|
58
|
+
- Release automation: GitHub release for every version tag; OIDC Trusted Publishing to PyPI for `master` tags only.
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
## Quick Start
|
|
62
|
+
|
|
63
|
+
1. Install the tool from PyPI:
|
|
64
|
+
```bash
|
|
65
|
+
uv tool install githubtemplateastraluv
|
|
66
|
+
```
|
|
67
|
+
2. Run it:
|
|
68
|
+
```bash
|
|
69
|
+
githubtemplateastraluv --help
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Usage
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# Print the version report (aligned columns)
|
|
76
|
+
githubtemplateastraluv --ver
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Output format:
|
|
80
|
+
```
|
|
81
|
+
Current Installed : X1.Y1.Z1
|
|
82
|
+
Latest @ PyPI : X2.Y2.Z2
|
|
83
|
+
Latest @ GitHub : X3.Y3.Z3
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
# Upgrade from PyPI (Linux; prints the manual command elsewhere)
|
|
88
|
+
githubtemplateastraluv --upgrade
|
|
89
|
+
|
|
90
|
+
# Force full re-download and reinstallation from PyPI
|
|
91
|
+
githubtemplateastraluv --upgrade --force
|
|
92
|
+
|
|
93
|
+
# Upgrade to the latest GitHub tagged release (any branch)
|
|
94
|
+
githubtemplateastraluv --upgrade --develop
|
|
95
|
+
|
|
96
|
+
# Force full re-download and reinstallation from GitHub
|
|
97
|
+
githubtemplateastraluv --upgrade --develop --force
|
|
98
|
+
|
|
99
|
+
# Uninstall (Linux; prints the manual command elsewhere)
|
|
100
|
+
githubtemplateastraluv --uninstall
|
|
101
|
+
|
|
102
|
+
# Full help screen
|
|
103
|
+
githubtemplateastraluv --help
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
## Install with Astral uv (PyPI — primary method)
|
|
108
|
+
|
|
109
|
+
#### Install
|
|
110
|
+
```bash
|
|
111
|
+
uv tool install githubtemplateastraluv
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Upgrade
|
|
115
|
+
```bash
|
|
116
|
+
githubtemplateastraluv --upgrade
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
#### Uninstall
|
|
120
|
+
```bash
|
|
121
|
+
uv tool uninstall githubtemplateastraluv
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Live execution with uvx (alternative method)
|
|
125
|
+
|
|
126
|
+
Run githubtemplateastraluv directly from PyPI without prior installation:
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
uvx githubtemplateastraluv
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
You can pass options as usual, for example:
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
uvx githubtemplateastraluv <args>
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Install and upgrade from GitHub (development releases)
|
|
139
|
+
|
|
140
|
+
A dedicated, non-primary distribution channel hosts intermediate and test
|
|
141
|
+
releases on GitHub: `https://github.com/Ogekuri/GitHub-Template-AstralUV`.
|
|
142
|
+
|
|
143
|
+
#### Install
|
|
144
|
+
```bash
|
|
145
|
+
uv tool install githubtemplateastraluv --force --from git+https://github.com/Ogekuri/GitHub-Template-AstralUV.git
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
#### Upgrade to the latest GitHub tagged release (any branch)
|
|
149
|
+
```bash
|
|
150
|
+
githubtemplateastraluv --upgrade --develop
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
#### Force full re-download and reinstallation
|
|
154
|
+
```bash
|
|
155
|
+
githubtemplateastraluv --upgrade --force
|
|
156
|
+
githubtemplateastraluv --upgrade --develop --force
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
`--upgrade --develop` always downloads the most recent tagged build
|
|
160
|
+
from GitHub, regardless of the branch it was tagged on
|
|
161
|
+
(`master`, `develop`, or any other branch). The `--ver` report shows the
|
|
162
|
+
GitHub latest release in the `Latest @ GitHub` row.
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
## Repository Tooling Scripts
|
|
167
|
+
|
|
168
|
+
| Script | Purpose |
|
|
169
|
+
| --- | --- |
|
|
170
|
+
| `scripts/templateastraluv.sh` | Local-run launcher delegating to `uv run --project <root> python -m githubtemplateastraluv`. |
|
|
171
|
+
| `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. |
|
|
172
|
+
| `scripts/clean.sh` | Removes every repository-internal execution-generated artifact and restores the canonical startup state. |
|
|
173
|
+
| `scripts/pre-release-check.sh` | Fail-fast release verification (syntax, compileall, pytest, out-of-tree build, artifact validation) with baseline-guarded cleanup. |
|
|
174
|
+
|
|
175
|
+
`scripts/clean.sh` removes `__pycache__/` and `*.egg-info/` at any depth,
|
|
176
|
+
the `.pytest_cache/`, `.ruff_cache/`, `.mypy_cache/`, `build/`, and
|
|
177
|
+
`.venv/` directories, and the `.coverage`/`.coverage.*` data files. It is
|
|
178
|
+
idempotent (absent targets are a successful no-op), never touches tracked
|
|
179
|
+
files, untracked user files, `$HOME` application data, or the versioned
|
|
180
|
+
release artifacts in `dist/`, and never runs destructive git commands.
|
|
181
|
+
`scripts/build.sh` delegates its pre-build cleanup to `scripts/clean.sh`,
|
|
182
|
+
so two consecutive builds always start from the identical state:
|
|
183
|
+
|
|
184
|
+
```bash
|
|
185
|
+
# Remove all execution-generated temporary artifacts
|
|
186
|
+
./scripts/clean.sh
|
|
187
|
+
|
|
188
|
+
# Build from the canonical cleaned state (also via clean.sh)
|
|
189
|
+
./scripts/build.sh
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
## Acknowledgments
|
|
194
|
+
|
|
195
|
+
TODO: fill scknowledgments section
|
|
196
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
githubtemplateastraluv/__init__.py,sha256=rRLix5adqRZzM0LOpsElZFBnTBZGtjts9MQVVAwBTK8,850
|
|
2
|
+
githubtemplateastraluv/__main__.py,sha256=I0zvcbC04AWVVNmpzMbI07EjM2uHAsEpKP_tbmIp8TA,497
|
|
3
|
+
githubtemplateastraluv/config.py,sha256=9YqNgNRTBGb3K8MKni-sLwm-Duijfgp7Fji-_sblEe0,25140
|
|
4
|
+
githubtemplateastraluv/config_render.py,sha256=_D9mPQJLfe7qH39KVXb0JNvSnox60BHCd1QDxIfPIew,18188
|
|
5
|
+
githubtemplateastraluv/core.py,sha256=5S64FY60FuipgyYfvg2cbXBvIsmCyLrescWj-v-niXA,3451
|
|
6
|
+
githubtemplateastraluv/management.py,sha256=CTBh0wuzoBkkNzHAZkfsHdhW-c0d5K5KzRFoGIAjE8U,9755
|
|
7
|
+
githubtemplateastraluv/version_check.py,sha256=ZMMNA2sbrC8U_JBBE8WkWPqKmbuMbGM7SQh2WTU33s4,15595
|
|
8
|
+
githubtemplateastraluv-0.0.2.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
|
|
9
|
+
githubtemplateastraluv-0.0.2.dist-info/METADATA,sha256=pXc8SyKAGjx60wTE00AMQ4fmS5Rr-NuhC584lFX5ySo,6543
|
|
10
|
+
githubtemplateastraluv-0.0.2.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
|
|
11
|
+
githubtemplateastraluv-0.0.2.dist-info/entry_points.txt,sha256=XH-1vjNI8srhhc8lbZSokz38NevfJvmhGA7yBwlD2sk,136
|
|
12
|
+
githubtemplateastraluv-0.0.2.dist-info/top_level.txt,sha256=NqyMg91W-TpzrQONNj83-3I1K46fe5MsYnan2RUY7mg,23
|
|
13
|
+
githubtemplateastraluv-0.0.2.dist-info/RECORD,,
|