From cd34422965a57ca09a599d3d4ef317d9af3ddb10 Mon Sep 17 00:00:00 2001 From: Angelo Peronio <22264609+angelo-peronio@users.noreply.github.com> Date: Mon, 14 Oct 2024 17:23:45 +0200 Subject: [PATCH] Docs --- README.md | 3 ++- development.md | 4 ++-- pyproject.toml | 3 ++- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 331f1a5..b3dfab0 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/development.md b/development.md index cc630df..4bf1fea 100644 --- a/development.md +++ b/development.md @@ -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 @@ -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) * * -* diff --git a/pyproject.toml b/pyproject.toml index b620c84..cca1996 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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 = [ @@ -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. # # Keep in sync with the pyupgrade configuration in .pre-commit.config.yaml. requires-python = ">= 3.10"