Skip to content

Commit 7e1389f

Browse files
seismanweiji14yvonnefroehlich
authored
Adopt SPEC 0 policy and drop NEP 29 policy (#3037)
Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Yvonne Fröhlich <[email protected]>
1 parent 4b7cb2a commit 7e1389f

File tree

6 files changed

+28
-34
lines changed

6 files changed

+28
-34
lines changed

.github/ISSUE_TEMPLATE/release_checklist.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ assignees: ''
1616
- [ ] Wrap Y ()
1717

1818
**Before release**:
19-
- [ ] Check [NEP29](https://numpy.org/neps/nep-0029-deprecation_policy.html) to see if we need to bump the minimum Python and NumPy versions
19+
- [ ] Check [SPEC 0](https://scientific-python.org/specs/spec-0000/) to see if we need to bump the minimum supported versions of Python and core package dependencies (NumPy/Pandas/Xarray)
2020
- [ ] Run `make codespell` to check common misspellings. If there are any, either fix them or add them to `ignore-words-list` in `pyproject.toml`
2121
- [ ] Check to ensure that:
2222
- [ ] All tests pass in the ["GMT Legacy Tests" workflow](https://github.com/GenericMappingTools/pygmt/actions/workflows/ci_tests_legacy.yaml)

.github/workflows/ci_tests.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# In draft pull request, only two jobs on Linux are triggered to save on
1818
# Continuous Integration resources:
1919
#
20-
# - Minimum [NEP29](https://numpy.org/neps/nep-0029-deprecation_policy) Python/NumPy versions
20+
# - Minimum supported Python/NumPy/Pandas/Xarray versions following [SPEC 0](https://scientific-python.org/specs/spec-0000/)
2121
# - Latest Python/NumPy versions + optional packages (e.g. GeoPandas)
2222
#
2323
name: Tests

README.rst

+9-10
Original file line numberDiff line numberDiff line change
@@ -253,16 +253,15 @@ Other non-official Python wrappers for GMT (not maintained):
253253

254254
.. doc-index-end-before
255255
256-
Minimum Supported GMT/Python/NumPy Versions
257-
-------------------------------------------
256+
Minimum Supported Versions
257+
--------------------------
258258

259-
PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__
260-
alongside the rest of the Scientific Python ecosystem, and therefore supports:
259+
PyGMT has adopted `SPEC 0 <https://scientific-python.org/specs/spec-0000/>`__ alongside
260+
the rest of the Scientific Python ecosystem, and therefore:
261261

262-
* All minor versions of Python released 42 months prior to the project, and at minimum
263-
the two latest minor versions.
264-
* All minor versions of NumPy released in the 24 months prior to the project, and at
265-
minimum the last three minor versions.
262+
* Support for Python versions be dropped 3 years after their initial release.
263+
* Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after their initial release.
266264

267-
For the supported GMT versions as well as the minimum required Python and NumPy versions
268-
please see `Minimum Required Versions <https://www.pygmt.org/dev/minversions.html>`__.
265+
For the supported GMT versions as well as the minimum required versions of Python and
266+
core package dependencies, please see
267+
`Minimum Supported Versions <https://www.pygmt.org/dev/minversions.html>`__.

doc/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
api/index.rst
4242
changes.md
43-
Minimum Supported Versions <minversions.rst>
43+
minversions.rst
4444

4545
.. toctree::
4646
:maxdepth: 2

doc/maintenance.md

+10-13
Original file line numberDiff line numberDiff line change
@@ -119,17 +119,15 @@ to change the default behaviour at <https://docs.readthedocs.io/en/stable/config
119119

120120
## Dependencies Policy
121121

122-
PyGMT has adopted [NEP29](https://numpy.org/neps/nep-0029-deprecation_policy)
123-
alongside the rest of the Scientific Python ecosystem, and therefore supports:
122+
PyGMT has adopted [SPEC 0](https://scientific-python.org/specs/spec-0000/) alongside
123+
the rest of the Scientific Python ecosystem, and therefore:
124124

125-
* All minor versions of Python released 42 months prior to the project,
126-
and at minimum the two latest minor versions.
127-
* All minor versions of NumPy released in the 24 months prior to the project,
128-
and at minimum the last three minor versions.
125+
* Support for Python versions be dropped 3 years after their initial release.
126+
* Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after their initial release.
129127

130-
In `pyproject.toml`, the `requires-python` key should be set to the minimum
131-
supported version of Python. Minimum Python and NumPy version support should be
132-
adjusted upward on every major and minor release, but never on a patch release.
128+
In `pyproject.toml`, the `requires-python` key should be set to the minimum supported
129+
version of Python. Minimum supported versions of Python and core package dependencies
130+
should be adjusted upward on every major and minor release, but never on a patch release.
133131

134132

135133
## Backwards Compatibility and Deprecation Policy
@@ -221,10 +219,9 @@ publishing the actual release notes at {doc}`changes`.
221219
GitHub accounts. Sort their names by the number of commits made since the
222220
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
223221
8. Update `doc/minversions.rst` with new information on the new release version,
224-
including a vX.Y.Z documentation link, and minimum required GMT/Python/NumPy
225-
versions. Follow
226-
[NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description)
227-
for updates.
222+
including a vX.Y.Z documentation link, and minimum required versions of GMT, Python
223+
and core package dependencies (NumPy/Pandas/Xarray). Follow
224+
[SPEC 0](https://scientific-python.org/specs/spec-0000/) for updates.
228225
9. Refresh citation information. Specifically, the BibTeX in `README.rst` and
229226
`CITATION.cff` needs to be updated with any metadata changes, including the
230227
DOI, release date, and version information. Please also follow

doc/minversions.rst

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
Minimum Supported GMT/Python/NumPy Versions
2-
-------------------------------------------
1+
Minimum Supported Versions
2+
--------------------------
33

4-
PyGMT has adopted `NEP29 <https://numpy.org/neps/nep-0029-deprecation_policy>`__
5-
alongside the rest of the Scientific Python ecosystem, and therefore supports:
4+
PyGMT has adopted `SPEC 0 <https://scientific-python.org/specs/spec-0000/>`__ alongside
5+
the rest of the Scientific Python ecosystem, and therefore:
66

7-
* All minor versions of Python released 42 months prior to the project, and at minimum
8-
the two latest minor versions.
9-
* All minor versions of NumPy released in the 24 months prior to the project, and at
10-
minimum the last three minor versions.
7+
* Support for Python versions be dropped 3 years after their initial release.
8+
* Support for core package dependencies (NumPy/Pandas/Xarray) be dropped 2 years after their initial release.
119

1210
.. list-table::
1311
:widths: 25 30 15 20 15

0 commit comments

Comments
 (0)