Merge branch 'main' into issue-236-config-and-enable-vale-in-pre-commit

Author: lwasser

.all-contributorsrc

@@ -533,6 +533,105 @@
         "code",
         "review"
       ]
+    },
+    {
+      "login": "kenseehart",
+      "name": "Ken Seehart",
+      "avatar_url": "https://avatars.githubusercontent.com/u/612119?v=4",
+      "profile": "https://github.com/kenseehart",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "ryanskeith",
+      "name": "Ryan",
+      "avatar_url": "https://avatars.githubusercontent.com/u/657220?v=4",
+      "profile": "https://github.com/ryanskeith",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "pb-413",
+      "name": "Patrick Byers",
+      "avatar_url": "https://avatars.githubusercontent.com/u/36516871?v=4",
+      "profile": "https://github.com/pb-413",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "sosey",
+      "name": "Megan Sosey",
+      "avatar_url": "https://avatars.githubusercontent.com/u/503615?v=4",
+      "profile": "http://www.stsci.edu/",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "BSuperbad",
+      "name": "Brianne Wilhelmi",
+      "avatar_url": "https://avatars.githubusercontent.com/u/100496041?v=4",
+      "profile": "https://github.com/BSuperbad",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "chenghlee",
+      "name": "Cheng H. Lee",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3485949?v=4",
+      "profile": "https://github.com/chenghlee",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "Vaunty",
+      "name": "Vaunty",
+      "avatar_url": "https://avatars.githubusercontent.com/u/68826427?v=4",
+      "profile": "https://github.com/Vaunty",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "zackw",
+      "name": "Zack Weinberg",
+      "avatar_url": "https://avatars.githubusercontent.com/u/325899?v=4",
+      "profile": "https://www.owlfolio.org/",
+      "contributions": [
+        "review"
+      ]
+    },
+    {
+      "login": "flpm",
+      "name": "Felipe Moreno",
+      "avatar_url": "https://avatars.githubusercontent.com/u/17676929?v=4",
+      "profile": "http://flpm.dev",
+      "contributions": [
+        "review",
+        "code"
+      ]
+    },
+    {
+      "login": "sn3hay",
+      "name": "Sneha Yadav",
+      "avatar_url": "https://avatars.githubusercontent.com/u/156010030?v=4",
+      "profile": "https://github.com/sn3hay",
+      "contributions": [
+        "code",
+        "review"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/build-book.yml

@@ -15,10 +15,10 @@ jobs:
   build-test-book:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: '3.9'
 
@@ -31,7 +31,7 @@ jobs:
       run: echo "::set-output name=dir::$(pip cache dir)"
 
     - name: Cache dependencies
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pip-cache.outputs.dir }}
         key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
@@ -46,7 +46,7 @@ jobs:
 
     # Save html as artifact
     - name: Save book html as artifact for viewing
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: book-html
         path: |

README.md

@@ -1,6 +1,6 @@
 # <img src="https://www.pyopensci.org/images/logo.png" width=100 /> pyOpenSci scientific Python Packaging Guide
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-51-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-61-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/pyopensci/python-package-guide?color=purple&display_name=tag&style=plastic)
@@ -140,6 +140,18 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/tylerjbonnell/"><img src="https://avatars.githubusercontent.com/u/89505514?v=4?s=100" width="100px;" alt="Tyler Bonnell"/><br /><sub><b>Tyler Bonnell</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Tyler-Bonnell" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ATyler-Bonnell" title="Reviewed Pull Requests">👀</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/pub/pat-tressel/2/b6/610"><img src="https://avatars.githubusercontent.com/u/618916?v=4?s=100" width="100px;" alt="Pat Tressel"/><br /><sub><b>Pat Tressel</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ptressel" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aptressel" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/kenseehart"><img src="https://avatars.githubusercontent.com/u/612119?v=4?s=100" width="100px;" alt="Ken Seehart"/><br /><sub><b>Ken Seehart</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=kenseehart" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Akenseehart" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/ryanskeith"><img src="https://avatars.githubusercontent.com/u/657220?v=4?s=100" width="100px;" alt="Ryan"/><br /><sub><b>Ryan</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=ryanskeith" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aryanskeith" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/pb-413"><img src="https://avatars.githubusercontent.com/u/36516871?v=4?s=100" width="100px;" alt="Patrick Byers"/><br /><sub><b>Patrick Byers</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=pb-413" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Apb-413" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.stsci.edu/"><img src="https://avatars.githubusercontent.com/u/503615?v=4?s=100" width="100px;" alt="Megan Sosey"/><br /><sub><b>Megan Sosey</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=sosey" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Asosey" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/BSuperbad"><img src="https://avatars.githubusercontent.com/u/100496041?v=4?s=100" width="100px;" alt="Brianne Wilhelmi"/><br /><sub><b>Brianne Wilhelmi</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=BSuperbad" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3ABSuperbad" title="Reviewed Pull Requests">👀</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/chenghlee"><img src="https://avatars.githubusercontent.com/u/3485949?v=4?s=100" width="100px;" alt="Cheng H. Lee"/><br /><sub><b>Cheng H. Lee</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=chenghlee" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Achenghlee" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Vaunty"><img src="https://avatars.githubusercontent.com/u/68826427?v=4?s=100" width="100px;" alt="Vaunty"/><br /><sub><b>Vaunty</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=Vaunty" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3AVaunty" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.owlfolio.org/"><img src="https://avatars.githubusercontent.com/u/325899?v=4?s=100" width="100px;" alt="Zack Weinberg"/><br /><sub><b>Zack Weinberg</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Azackw" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://flpm.dev"><img src="https://avatars.githubusercontent.com/u/17676929?v=4?s=100" width="100px;" alt="Felipe Moreno"/><br /><sub><b>Felipe Moreno</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Aflpm" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/pyOpenSci/python-package-guide/commits?author=flpm" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sn3hay"><img src="https://avatars.githubusercontent.com/u/156010030?v=4?s=100" width="100px;" alt="Sneha Yadav"/><br /><sub><b>Sneha Yadav</b></sub></a><br /><a href="https://github.com/pyOpenSci/python-package-guide/commits?author=sn3hay" title="Code">💻</a> <a href="https://github.com/pyOpenSci/python-package-guide/pulls?q=is%3Apr+reviewed-by%3Asn3hay" title="Reviewed Pull Requests">👀</a></td>
     </tr>
   </tbody>
 </table>

documentation/repository-files/readme-file-best-practices.md

@@ -6,7 +6,7 @@ sees before they install your package.
 
 The README.md file is the landing page of:
 
-* Your package as it appears on a repository site such as PyPI or Anaconda
+* Your package as it appears on a repository site such as PyPI or Anaconda.org
 * Your package's GitHub repository
 
 Your README.md file is also used as a measure of package and community
@@ -68,7 +68,7 @@ README file for others to quickly browse.
 
 Some badges that you might consider adding to your README file include:
 
-* Current version of the package on PyPI / Anaconda Cloud
+* Current version of the package on PyPI / Anaconda.org
 
 Example: [![PyPI version shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)
 
@@ -114,7 +114,7 @@ file.
 ### ✔️ Installation instructions
 
 Include instructions for installing your package. If you have published
-the package on both PyPI and Anaconda Cloud be sure to include instructions for both.
+the package on both PyPI and Anaconda.org, be sure to include instructions for both.
 
 ### ✔️ Document any additional setup required
 

examples/extension-hatch/README

@@ -0,0 +1,3 @@
+An example Python package used to support Python packaging tutorials
+
+This project demonstrates mixing C and Python code by using the frontend hatch with the backend mesonpy

examples/extension-hatch/examplePy/__init__.py

@@ -0,0 +1,4 @@
+from .temperature import celsius_to_fahrenheit, fahrenheit_to_celsius
+
+__all__ = ["celsius_to_fahrenheit", "fahrenheit_to_celsius"]
+__version__ = "0.1.0dev0"

examples/extension-hatch/examplePy/meson.build

@@ -0,0 +1,15 @@
+py.extension_module(
+  'temperature',
+  'temperature.c',
+  install: true,
+  subdir: 'examplePy'
+)
+
+python_sources = [
+  '__init__.py'
+]
+
+py.install_sources(
+  python_sources,
+  subdir: 'examplePy'
+)

examples/extension-hatch/examplePy/temperature.c

@@ -0,0 +1,63 @@
+#define PY_SSIZE_T_CLEAN
+#include <Python.h>
+
+static PyObject *
+temperature_celsius_to_fahrenheit(PyObject *self, PyObject *args)
+{
+    long celsius;
+    long fahrenheit;
+    PyObject *ret;
+
+    if (!PyArg_ParseTuple(args, "l", &celsius))
+        return NULL;
+
+    fahrenheit = (celsius * 9/5) + 32;
+
+    ret = PyLong_FromLong(fahrenheit);
+    Py_INCREF(ret);
+    return ret;
+}
+
+static PyObject *
+temperature_fahrenheit_to_celsius(PyObject *self, PyObject *args)
+{
+    long fahrenheit;
+    long celsius;
+    PyObject *ret;
+
+    if (!PyArg_ParseTuple(args, "l", &fahrenheit))
+        return NULL;
+
+    celsius = (fahrenheit - 32) * 9/5;
+
+    ret = PyLong_FromLong(celsius);
+    Py_INCREF(ret);
+    return ret;
+}
+
+static PyMethodDef CoreMethods[] = {
+    {"celsius_to_fahrenheit",  temperature_celsius_to_fahrenheit, METH_VARARGS, "Convert temperature from Celsius to Fahrenheit"},
+    {"fahrenheit_to_celsius",  temperature_fahrenheit_to_celsius, METH_VARARGS, "Convert temperature from Fahrenheit to Celsius"},
+    {NULL, NULL, 0, NULL}        /* Sentinel */
+};
+
+static struct PyModuleDef temperaturemodule = {
+    PyModuleDef_HEAD_INIT,
+    "temperature",   /* name of module */
+    NULL,     /* module documentation, may be NULL */
+    -1,       /* size of per-interpreter state of the module,
+                 or -1 if the module keeps state in global variables. */
+    CoreMethods
+};
+
+PyMODINIT_FUNC
+PyInit_temperature(void)
+{
+    PyObject *m;
+
+    m = PyModule_Create(&temperaturemodule);
+    if (m == NULL)
+        return NULL;
+
+    return m;
+}

examples/extension-hatch/meson.build

@@ -0,0 +1,20 @@
+project(
+  'examplePy',
+  'c',
+  version: '0.1.dev0',
+  license: 'MIT',
+  meson_version: '>= 0.64.0',
+  default_options: [
+    'buildtype=debugoptimized',
+    'c_std=c99',
+    'cpp_std=c++14',
+  ],
+)
+
+cc = meson.get_compiler('c')
+
+py_mod = import('python')
+py = py_mod.find_installation(pure: false)
+py_dep = py.dependency()
+
+subdir('examplePy')

examples/extension-hatch/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+build-backend = "mesonpy"
+requires = [
+  "meson-python>=0.13.0rc0",
+]
+
+[project]
+name = "examplePy"
+version = "0.1"
+authors = [
+    {name = "Some Maintainer", email = "[email protected]"},
+]
+maintainers = [
+    {name = "All the contributors"},
+]
+description = "An example Python package used to support Python packaging tutorials"
+keywords = ["pyOpenSci", "python packaging"]
+readme = "README"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+]