Skip to content

Commit babf682

Browse files
fix: better support for uvx (#590)
* fix: better support for uvx Signed-off-by: Henry Schreiner <[email protected]> * style: pre-commit fixes --------- Signed-off-by: Henry Schreiner <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent bc3e119 commit babf682

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ Guide][] at [scientific-python/cookie][] for [repo-review][].
223223
This tool can check the style of a repository. Use like this:
224224

225225
```bash
226-
uv run --extra=cli sp-repo-review <path to repository>
226+
uvx sp-repo-review[cli] <path to repository>
227227
```
228228

229229
This will produce a list of results - green checkmarks mean this rule is
@@ -248,6 +248,13 @@ somewhere else, then all the pytest checks will be skipped.
248248
This was originally developed for [Scikit-HEP][] before moving to Scientific
249249
Python.
250250

251+
## Extras
252+
253+
- `cli`: Dependencies to run the CLI (not needed for programmatic access, like
254+
on Web Assembly)
255+
- `pyproject`: Include validate pyproject with schema store.
256+
- `all`: All extras
257+
251258
## Other ways to use
252259

253260
You can also use GitHub Actions:

pyproject.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,17 @@ cli = [
4343
pyproject = [
4444
"validate-pyproject-schema-store[all]",
4545
]
46+
all = [
47+
"sp-repo-review[cli,pyproject]",
48+
]
4649

4750
[project.urls]
4851
Guide = "https://learn.scientific-python.org/development"
4952
Homepage = "https://github.com/scientific-python/cookie"
5053
Preview = "https://scientific-python-cookie.readthedocs.io"
5154
Source = "https://github.com/scientific-python/cookie"
5255

53-
54-
[project.entry-points."pipx.run"]
56+
[project.scripts]
5557
sp-repo-review = "repo_review.__main__:main"
5658

5759
[project.entry-points."repo_review.checks"]

0 commit comments

Comments
 (0)