uvx-gh 0.1.0__tar.gz

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.
@@ -0,0 +1,14 @@
1
+ # Python-generated files
2
+ __pycache__/
3
+ *.py[oc]
4
+ build/
5
+ dist/
6
+ wheels/
7
+ *.egg-info
8
+
9
+ # Virtual environments
10
+ .venv
11
+
12
+ .DS_Store
13
+ .python-version
14
+ .env
@@ -0,0 +1,62 @@
1
+ # See https://pre-commit.com for more information
2
+ # See https://pre-commit.com/hooks.html for more hooks
3
+ repos:
4
+ - repo: https://github.com/pre-commit/pre-commit-hooks
5
+ rev: v6.0.0
6
+ hooks:
7
+ - id: check-yaml
8
+ - id: check-toml
9
+ - id: check-json
10
+ - id: check-case-conflict
11
+ - id: check-docstring-first
12
+ - id: check-added-large-files
13
+ - id: check-executables-have-shebangs
14
+ - id: debug-statements
15
+ - id: end-of-file-fixer
16
+ - id: trailing-whitespace
17
+ files: "\\.(py|txt|yaml|json|md|toml|lock|cfg|html|sh|js|yml)$"
18
+ - id: mixed-line-ending
19
+ files: "\\.(py|txt|yaml|json|md|toml|lock|cfg|html|sh|js|yml)$"
20
+ - id: fix-byte-order-marker
21
+ - id: name-tests-test
22
+ - id: requirements-txt-fixer
23
+
24
+ - repo: https://github.com/pycqa/isort
25
+ rev: "7.0.0"
26
+ hooks:
27
+ - id: isort
28
+ files: "\\.(py)$"
29
+ args: [--settings-path=pyproject.toml]
30
+
31
+ - repo: https://github.com/hadialqattan/pycln
32
+ rev: v2.6.0 # Possible releases: https://github.com/hadialqattan/pycln/releases
33
+ hooks:
34
+ - id: pycln
35
+ args: [--config=pyproject.toml]
36
+
37
+ - repo: https://github.com/pre-commit/mirrors-mypy
38
+ rev: "v1.19.1"
39
+ hooks:
40
+ - id: mypy
41
+ args: ["--config=pyproject.toml"]
42
+ additional_dependencies:
43
+ - pydantic
44
+ - pydantic_settings
45
+ - typer
46
+ - uvicorn
47
+ - fastapi
48
+ - httpx
49
+ - asyncache
50
+ - pytest
51
+ - types-pytz
52
+ - types-cachetools
53
+ - types-requests
54
+
55
+ - repo: https://github.com/astral-sh/ruff-pre-commit
56
+ rev: v0.14.14
57
+ hooks:
58
+ - id: ruff-check
59
+ types_or: [python, pyi]
60
+ args: [--fix]
61
+ - id: ruff-format
62
+ types_or: [python, pyi]
uvx_gh-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 qsoyq
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
uvx_gh-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,109 @@
1
+ Metadata-Version: 2.4
2
+ Name: uvx-gh
3
+ Version: 0.1.0
4
+ Summary: Thin wrapper to uvx-run a tool from github.com/<user>/<tool>[@<ref>].
5
+ Project-URL: Homepage, https://github.com/qsoyq/uvx-gh
6
+ Project-URL: Repository, https://github.com/qsoyq/uvx-gh
7
+ Project-URL: Issues, https://github.com/qsoyq/uvx-gh/issues
8
+ Author: qsoyq
9
+ License: MIT
10
+ License-File: LICENSE
11
+ Keywords: cli,github,uv,uvx,wrapper
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: MIT License
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Topic :: Software Development
25
+ Classifier: Topic :: System :: Software Distribution
26
+ Requires-Python: >=3.10
27
+ Requires-Dist: dulwich>=0.22
28
+ Requires-Dist: typer>=0.12
29
+ Description-Content-Type: text/markdown
30
+
31
+ # uvx-gh
32
+
33
+ Thin wrapper to `uvx`-run a tool published as a GitHub repo at `github.com/<user>/<tool>[@<ref>]`.
34
+
35
+ ## Install
36
+
37
+ ```bash
38
+ # One-off run
39
+ uvx uvx-gh alice/foo
40
+
41
+ # Or install
42
+ pip install uvx-gh
43
+ # pip install git+https://github.com/qsoyq/uvx-gh.git # latest from GitHub
44
+ ```
45
+
46
+ ## Usage
47
+
48
+ ```text
49
+ uvx-gh [uvx-options...] USER/TOOL[@REF] [tool-args...]
50
+ uvx-gh [uvx-options...] --user USER TOOL[@REF] [tool-args...]
51
+ ```
52
+
53
+ The `USER/TOOL` short path takes priority over `--user`. Either is required.
54
+
55
+ ### Ref suffix
56
+
57
+ | Spec | Behavior |
58
+ | ----------------- | ----------------------------------------------------------------------------------- |
59
+ | `alice/foo` | use locally cached HEAD sha; first call resolves via `git ls-remote` and persists |
60
+ | `alice/foo@latest`| force re-resolve HEAD via `git ls-remote` and overwrite the cached sha |
61
+ | `alice/foo@v1.2.3`| pin to git ref (tag / branch / sha) directly — bypasses the sha cache |
62
+
63
+ ### Why the sha cache?
64
+
65
+ `uvx --from git+https://...` (without a pinned commit) makes `uv` re-fetch HEAD from GitHub on every call — that's a network roundtrip per invocation. `uvx-gh` resolves HEAD itself via the smart-HTTP `ls-remote` protocol (using dulwich, no system git needed) and pins the URL to the resolved sha (`git+...@<sha>`). After the first run, subsequent calls hit the local cache and incur **zero network traffic** until you explicitly use `@latest`.
66
+
67
+ Cache location:
68
+
69
+ - `$UVX_GH_CACHE_HOME` if set
70
+ - otherwise `$XDG_CACHE_HOME/uvx-gh/` (default `~/.cache/uvx-gh/`)
71
+
72
+ Layout: `<cache_dir>/github.com/<user>/<tool>` containing the sha as a single line.
73
+
74
+ ### Pass-through
75
+
76
+ Anything the wrapper does not recognize is forwarded:
77
+
78
+ - Tokens before `TOOL_SPEC` go to `uvx` (e.g. `--python 3.12`, `--with extras`)
79
+ - Tokens after `TOOL_SPEC` go to the tool itself
80
+ - `--` ends wrapper-arg parsing; everything after `--` is treated as tool args
81
+
82
+ ```bash
83
+ uvx-gh --python 3.12 alice/foo --port 8080
84
+ # → uvx --python 3.12 --from git+https://github.com/alice/foo foo --port 8080
85
+
86
+ uvx-gh -- alice/foo --user bob
87
+ # → uvx --from git+https://github.com/alice/foo foo --user bob
88
+ # (--user bob is forwarded to foo, NOT consumed by uvx-gh)
89
+ ```
90
+
91
+ ## Requirements
92
+
93
+ `uvx-gh` depends on the `uv` toolchain (which provides the `uvx` binary). It does **not** require the system `git` CLI — HEAD resolution uses [dulwich](https://github.com/jelmer/dulwich) (pure Python, bundled as a runtime dep).
94
+
95
+ Install `uv`:
96
+
97
+ | Platform | Command |
98
+ | -------- | ---------------------------------------------------------------- |
99
+ | macOS | `brew install uv` |
100
+ | Linux | `curl -LsSf https://astral.sh/uv/install.sh \| sh` |
101
+ | Windows | `winget install --id=astral-sh.uv -e` |
102
+ | Any | `pipx install uv` |
103
+
104
+ `uvx-gh` runs a pre-flight check at startup and exits with a friendly message if `uvx` is not on `PATH`.
105
+
106
+ ## Notes
107
+
108
+ - On Windows, `os.execvp` is emulated; signal/exit-code semantics differ slightly from POSIX.
109
+ - The `UVX_VALUE_FLAGS` whitelist in `uvx_gh/commands/main.py` is hand-synced with `uv`'s value-taking flags. Use `--flag=value` form to bypass the whitelist if a new uv flag is missing.
uvx_gh-0.1.0/README.md ADDED
@@ -0,0 +1,79 @@
1
+ # uvx-gh
2
+
3
+ Thin wrapper to `uvx`-run a tool published as a GitHub repo at `github.com/<user>/<tool>[@<ref>]`.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ # One-off run
9
+ uvx uvx-gh alice/foo
10
+
11
+ # Or install
12
+ pip install uvx-gh
13
+ # pip install git+https://github.com/qsoyq/uvx-gh.git # latest from GitHub
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ ```text
19
+ uvx-gh [uvx-options...] USER/TOOL[@REF] [tool-args...]
20
+ uvx-gh [uvx-options...] --user USER TOOL[@REF] [tool-args...]
21
+ ```
22
+
23
+ The `USER/TOOL` short path takes priority over `--user`. Either is required.
24
+
25
+ ### Ref suffix
26
+
27
+ | Spec | Behavior |
28
+ | ----------------- | ----------------------------------------------------------------------------------- |
29
+ | `alice/foo` | use locally cached HEAD sha; first call resolves via `git ls-remote` and persists |
30
+ | `alice/foo@latest`| force re-resolve HEAD via `git ls-remote` and overwrite the cached sha |
31
+ | `alice/foo@v1.2.3`| pin to git ref (tag / branch / sha) directly — bypasses the sha cache |
32
+
33
+ ### Why the sha cache?
34
+
35
+ `uvx --from git+https://...` (without a pinned commit) makes `uv` re-fetch HEAD from GitHub on every call — that's a network roundtrip per invocation. `uvx-gh` resolves HEAD itself via the smart-HTTP `ls-remote` protocol (using dulwich, no system git needed) and pins the URL to the resolved sha (`git+...@<sha>`). After the first run, subsequent calls hit the local cache and incur **zero network traffic** until you explicitly use `@latest`.
36
+
37
+ Cache location:
38
+
39
+ - `$UVX_GH_CACHE_HOME` if set
40
+ - otherwise `$XDG_CACHE_HOME/uvx-gh/` (default `~/.cache/uvx-gh/`)
41
+
42
+ Layout: `<cache_dir>/github.com/<user>/<tool>` containing the sha as a single line.
43
+
44
+ ### Pass-through
45
+
46
+ Anything the wrapper does not recognize is forwarded:
47
+
48
+ - Tokens before `TOOL_SPEC` go to `uvx` (e.g. `--python 3.12`, `--with extras`)
49
+ - Tokens after `TOOL_SPEC` go to the tool itself
50
+ - `--` ends wrapper-arg parsing; everything after `--` is treated as tool args
51
+
52
+ ```bash
53
+ uvx-gh --python 3.12 alice/foo --port 8080
54
+ # → uvx --python 3.12 --from git+https://github.com/alice/foo foo --port 8080
55
+
56
+ uvx-gh -- alice/foo --user bob
57
+ # → uvx --from git+https://github.com/alice/foo foo --user bob
58
+ # (--user bob is forwarded to foo, NOT consumed by uvx-gh)
59
+ ```
60
+
61
+ ## Requirements
62
+
63
+ `uvx-gh` depends on the `uv` toolchain (which provides the `uvx` binary). It does **not** require the system `git` CLI — HEAD resolution uses [dulwich](https://github.com/jelmer/dulwich) (pure Python, bundled as a runtime dep).
64
+
65
+ Install `uv`:
66
+
67
+ | Platform | Command |
68
+ | -------- | ---------------------------------------------------------------- |
69
+ | macOS | `brew install uv` |
70
+ | Linux | `curl -LsSf https://astral.sh/uv/install.sh \| sh` |
71
+ | Windows | `winget install --id=astral-sh.uv -e` |
72
+ | Any | `pipx install uv` |
73
+
74
+ `uvx-gh` runs a pre-flight check at startup and exits with a friendly message if `uvx` is not on `PATH`.
75
+
76
+ ## Notes
77
+
78
+ - On Windows, `os.execvp` is emulated; signal/exit-code semantics differ slightly from POSIX.
79
+ - The `UVX_VALUE_FLAGS` whitelist in `uvx_gh/commands/main.py` is hand-synced with `uv`'s value-taking flags. Use `--flag=value` form to bypass the whitelist if a new uv flag is missing.
@@ -0,0 +1,133 @@
1
+ [project]
2
+ name = "uvx-gh"
3
+ version = "0.1.0"
4
+ description = "Thin wrapper to uvx-run a tool from github.com/<user>/<tool>[@<ref>]."
5
+ readme = "README.md"
6
+ requires-python = ">=3.10"
7
+ license = { text = "MIT" }
8
+ authors = [{ name = "qsoyq" }]
9
+ keywords = ["uvx", "uv", "github", "cli", "wrapper"]
10
+ classifiers = [
11
+ "Development Status :: 4 - Beta",
12
+ "Environment :: Console",
13
+ "Intended Audience :: Developers",
14
+ "License :: OSI Approved :: MIT License",
15
+ "Operating System :: OS Independent",
16
+ "Programming Language :: Python :: 3",
17
+ "Programming Language :: Python :: 3 :: Only",
18
+ "Programming Language :: Python :: 3.10",
19
+ "Programming Language :: Python :: 3.11",
20
+ "Programming Language :: Python :: 3.12",
21
+ "Programming Language :: Python :: 3.13",
22
+ "Programming Language :: Python :: 3.14",
23
+ "Topic :: Software Development",
24
+ "Topic :: System :: Software Distribution",
25
+ ]
26
+ dependencies = [
27
+ "dulwich>=0.22",
28
+ "typer>=0.12",
29
+ ]
30
+
31
+ [project.urls]
32
+ Homepage = "https://github.com/qsoyq/uvx-gh"
33
+ Repository = "https://github.com/qsoyq/uvx-gh"
34
+ Issues = "https://github.com/qsoyq/uvx-gh/issues"
35
+
36
+ [project.scripts]
37
+ uvx-gh = "uvx_gh.commands.main:cmd"
38
+
39
+ [dependency-groups]
40
+ dev = [
41
+ "ipython>=8.37.0",
42
+ "pre-commit>=4.5.1",
43
+ "pytest>=8.0",
44
+ ]
45
+
46
+ [tool.hatch.build.targets.wheel]
47
+ packages = ["uvx_gh"]
48
+
49
+ [build-system]
50
+ requires = ["hatchling"]
51
+ build-backend = "hatchling.build"
52
+
53
+ [tool.ruff]
54
+ # Exclude a variety of commonly ignored directories.
55
+ exclude = [
56
+ ".bzr",
57
+ ".direnv",
58
+ ".eggs",
59
+ ".git",
60
+ ".git-rewrite",
61
+ ".hg",
62
+ ".ipynb_checkpoints",
63
+ ".mypy_cache",
64
+ ".nox",
65
+ ".pants.d",
66
+ ".pyenv",
67
+ ".pytest_cache",
68
+ ".pytype",
69
+ ".ruff_cache",
70
+ ".svn",
71
+ ".tox",
72
+ ".venv",
73
+ ".vscode",
74
+ "__pypackages__",
75
+ "_build",
76
+ "buck-out",
77
+ "build",
78
+ "dist",
79
+ "node_modules",
80
+ "site-packages",
81
+ "venv",
82
+ ]
83
+ # Same as Black.
84
+ line-length = 200
85
+ indent-width = 4
86
+
87
+ [tool.ruff.lint]
88
+ # Enable Pyflakes (`F`) and a subset of the pycodestyle (`E`) codes by default.
89
+ # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
90
+ # McCabe complexity (`C901`) by default.
91
+ select = ["E4", "E7", "E9", "F"]
92
+ ignore = []
93
+ # Allow fix for all enabled rules (when `--fix`) is provided.
94
+ fixable = ["ALL"]
95
+ unfixable = []
96
+ # Allow unused variables when underscore-prefixed.
97
+ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
98
+
99
+ [tool.ruff.format]
100
+ # Like Black, use double quotes for strings.
101
+ quote-style = "double"
102
+ # Like Black, indent with spaces, rather than tabs.
103
+ indent-style = "space"
104
+ # Like Black, respect magic trailing commas.
105
+ skip-magic-trailing-comma = false
106
+ # Like Black, automatically detect the appropriate line ending.
107
+ line-ending = "auto"
108
+ # Enable auto-formatting of code examples in docstrings. Markdown,
109
+ # reStructuredText code/literal blocks and doctests are all supported.
110
+ #
111
+ # This is currently disabled by default, but it is planned for this
112
+ # to be opt-out in the future.
113
+ docstring-code-format = true
114
+
115
+ # Set the line length limit used when formatting code snippets in
116
+ # docstrings.
117
+ #
118
+ # This only has an effect when the `docstring-code-format` setting is
119
+ # enabled.
120
+ # docstring-code-line-length = "dynamic"
121
+
122
+ [tool.mypy]
123
+ warn_return_any = true
124
+ warn_unused_configs = true
125
+ ignore_missing_imports = false
126
+ exclude = ['^venv/', '^__init__\.py$']
127
+ explicit_package_bases = true
128
+
129
+ [tool.pytest.ini_options]
130
+ markers = []
131
+
132
+ [tool.isort]
133
+ profile = "hug"
@@ -0,0 +1,5 @@
1
+ import shutil
2
+
3
+
4
+ def test_cmd():
5
+ assert shutil.which("uvx-gh") is not None