Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
angelo-peronio committed Oct 14, 2024
1 parent 356246d commit cd34422
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@
[![python](https://img.shields.io/pypi/pyversions/gsffile)](https://pypi.org/project/gsffile/)
[![license](https://img.shields.io/github/license/angelo-peronio/gsffile?color=2DBA4E)](https://github.com/angelo-peronio/gsffile/blob/master/LICENSE)
[![ci](https://github.com/angelo-peronio/gsffile/actions/workflows/ci.yaml/badge.svg)](https://github.com/angelo-peronio/gsffile/actions/workflows/ci.yaml)
[![codecov](https://codecov.io/github/angelo-peronio/gsffile/graph/badge.svg)](https://codecov.io/github/angelo-peronio/gsffile)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/angelo-peronio/gsffile/master.svg)](https://results.pre-commit.ci/latest/github/angelo-peronio/gsffile/master)
[![codecov](https://codecov.io/github/angelo-peronio/gsffile/graph/badge.svg)](https://codecov.io/github/angelo-peronio/gsffile)
[![SPEC 0 — Minimum Supported Dependencies](https://img.shields.io/badge/SPEC-0-green?labelColor=%23004811&color=%235CA038)](https://scientific-python.org/specs/spec-0000/)
[![ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/format.json)](https://github.com/astral-sh/ruff)

`gsffile` is a Python library to:
Expand Down
4 changes: 2 additions & 2 deletions development.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Use `scripts\Release-Package.ps1`:
## Roadmap

* [ ] Document logging in readme
* [ ] Fix codecov upload
* [ ] Recolor badges
* [ ] "post" version numbering
* [ ] ci
* [ ] Test workflow to gate pull requests / [branch protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets), see [pytest](https://github.com/pytest-dev/pytest/tree/main/.github/workflows)
* [ ] Test installed wheel in CI
Expand All @@ -23,4 +24,3 @@ Use `scripts\Release-Package.ps1`:
* [repo-review](https://learn.scientific-python.org/development/guides/repo-review/?repo=angelo-peronio%2Fgsffile&branch=master)
* <https://hynek.me/articles/ditch-codecov-python>
* <https://hynek.me/articles/python-github-actions/>
* <https://cjolowicz.github.io/posts/hypermodern-python-06-ci-cd/#coverage-reporting-with-codecov>
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ authors = [{ name = "Carlo Dri" }, { name = "Angelo Peronio" }]
keywords = ["Gwyddion", "Gwyddion Simple Field", "gsf"]
dynamic = ["version"]
readme = "README.md"
# Test will run against the Python versions listed in the Trove classifiers.
# Support the next pre-release Python version only after NumPy has published
# binary wheels for it, otherwise the CI would take too long.
classifiers = [
Expand All @@ -23,7 +24,7 @@ classifiers = [
"Topic :: Scientific/Engineering :: Image Processing",
"Typing :: Typed",
]
# Scientific Python reccomendation on Python and NumPy versions to support.
# Scientific Python recommendation on Python and NumPy versions to support.
# <https://scientific-python.org/specs/spec-0000/>
# Keep in sync with the pyupgrade configuration in .pre-commit.config.yaml.
requires-python = ">= 3.10"
Expand Down

0 comments on commit cd34422

Please sign in to comment.