Skip to content

Commit 0006a06

Browse files
authored
docs: clean up a few references to scikit-hep, add a little attribution (#178)
* docs: clean up a few references to scikit-hep, add a little attribution Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * docs: add some fixes for sp-repo-review docs & metadata Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
1 parent 33928cd commit 0006a06

3 files changed

Lines changed: 33 additions & 10 deletions

File tree

README-rr.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![PyPI platforms][pypi-platforms]][pypi-link]
99

1010
`sp-repo-review` provides checks based on the [Scientific-Python Development
11-
Guide][] at [scientific-python/cookie][].
11+
Guide][] at [scientific-python/cookie][] for [repo-review][].
1212

1313
This tool can check the style of a repository. Use like this:
1414

@@ -34,15 +34,34 @@ follow them, some of the checks might not work. For example, the guidelines
3434
specify pytest configuration be placed in `pyproject.toml`. If you place it
3535
somewhere else, then all the pytest checks will be skipped.
3636

37+
This was originally developed for [Scikit-HEP][] before moving to Scientific
38+
Python.
39+
40+
You can also use GitHub Actions:
41+
42+
```yaml
43+
- uses: scientific-python/cookie@<version>
44+
```
45+
46+
Or pre-commit:
47+
48+
```yaml
49+
- repo: https://github.com/scientific-python/cookie
50+
rev: <version>
51+
hooks:
52+
- id: sp-repo-review
53+
```
54+
3755
<!-- prettier-ignore-start -->
3856
3957
[actions-badge]: https://github.com/scientific-python/cookie/workflows/CI/badge.svg
4058
[actions-link]: https://github.com/scientific-python/cookie/actions
4159
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
42-
[github-discussions-link]: https://github.com/scikit-hep/cookie/discussions
60+
[github-discussions-link]: https://github.com/scientific-python/cookie/discussions
4361
[pypi-link]: https://pypi.org/project/sp-repo-review/
4462
[pypi-platforms]: https://img.shields.io/pypi/pyversions/sp-repo-review
4563
[pypi-version]: https://badge.fury.io/py/sp-repo-review.svg
64+
[repo-review]: https://repo-review.readthedocs.io
4665
[rtd-badge]: https://readthedocs.org/projects/scientific-python-cookie/badge/?version=latest
4766
[rtd-link]: https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
4867
[scientific-python development guide]: https://learn.scientific-python.org/development

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ templates for Python packages?
2121
- Provides [`sp-repo-review`][pypi-link] to evaluate existing repos against the
2222
guidelines, with a WebAssembly version integrated with the guide. All checks
2323
cross-linked.
24-
- Follows PyPA best practices and regularly updated.
24+
- Follows [PyPA][] best practices and regularly updated.
2525

2626
Be sure you have read the [Scientific-Python Development Guide][] first, and
2727
possibly used them on a project or two. This is _not_ a minimal example or
@@ -175,36 +175,39 @@ not use pre-commit properly. It also has quite a bit of custom code.
175175
#### History
176176

177177
A lot of the guide, cookiecutter, and repo-review started out as part of
178-
Scikit-HEP. These projects were merged, generalized, and combined with the
179-
NSLS-II guide during the 2023 Scientific-Python Developers Summit.
178+
[Scikit-HEP][]. These projects were merged, generalized, and combined with the
179+
[NSLS-II][] guide during the 2023 Scientific-Python Developers Summit.
180180

181181
<!-- prettier-ignore-start -->
182182

183-
[actions-badge]: https://github.com/scikit-hep/cookie/workflows/CI/badge.svg
184-
[actions-link]: https://github.com/scikit-hep/cookie/actions
183+
[actions-badge]: https://github.com/scientific-python/cookie/workflows/CI/badge.svg
184+
[actions-link]: https://github.com/scientific-python/cookie/actions
185185
[cibuildwheel]: https://cibuildwheel.readthedocs.io
186186
[cookiecutter]: https://cookiecutter.readthedocs.io
187187
[copier]: https://copier.readthedocs.io
188188
[flit]: https://flit.readthedocs.io/en/latest/
189189
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
190-
[github-discussions-link]: https://github.com/scikit-hep/cookie/discussions
190+
[github-discussions-link]: https://github.com/scientific-python/cookie/discussions
191191
[hatch]: https://github.com/ofek/hatch
192192
[hypermodern]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
193193
[maturin]: https://maturin.rs
194194
[meson-python]: https://meson-python.readthedocs.io
195195
[nox]: https://nox.thea.codes/en/stable/
196+
[nsls-ii]: https://nsls-ii.github.io/scientific-python-cookiecutter/
196197
[pdm]: https://pdm.fming.dev
197198
[pep 621]: https://www.python.org/dev/peps/pep-0621
198199
[pipx]: https://pypa.github.io/pipx/
199200
[poetry]: https://python-poetry.org
200201
[pybind11]: https://pybind11.readthedocs.io
202+
[pypa]: https://www.pypa.io
201203
[pypi-link]: https://pypi.org/project/sp-repo-review/
202204
[pypi-platforms]: https://img.shields.io/pypi/pyversions/sp-repo-review
203205
[pypi-version]: https://badge.fury.io/py/sp-repo-review.svg
204206
[rtd-badge]: https://readthedocs.org/projects/scientific-python-cookie/badge/?version=latest
205207
[rtd-link]: https://scientific-python-cookie.readthedocs.io/en/latest/?badge=latest
206208
[scientific-python development guide]: https://learn.scientific-python.org/development
207209
[scikit-build]: https://scikit-build.readthedocs.io
210+
[scikit-hep]: https://scikit-hep.org
208211
[setuptools]: https://setuptools.readthedocs.io
209212
[trampolim]: https://trampolim.readthedocs.io
210213
[whey]: https://whey.readthedocs.io

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,10 @@ dev = [
4747
]
4848

4949
[project.urls]
50-
Homepage = "https://github.com/scientific-python/cookie"
51-
Webpage = "https://scientific-python.github.io/cookie"
50+
Guide = "https://learn.scientific-python.org/development"
51+
Homepage = "https://scientific-python.github.io/cookie"
5252
Preview = "https://scientific-python-cookie.readthedocs.io"
53+
Source = "https://github.com/scientific-python/cookie"
5354

5455

5556
[project.entry-points."pipx.run"]

0 commit comments

Comments
 (0)