Merge branch 'main' into ci/autoupdate-translation-stats

Author: RobPasMue

.all-contributorsrc

@@ -866,6 +866,55 @@
         "code",
         "review"
       ]
+    },
+    {
+      "login": "akhilkrishnar0",
+      "name": "Akhil Krishna R",
+      "avatar_url": "https://avatars.githubusercontent.com/u/164136572?v=4",
+      "profile": "https://sites.google.com/res.christuniversity.in/akhilkrishnar/about?pli=1",
+      "contributions": [
+        "ideas",
+        "review"
+      ]
+    },
+    {
+      "login": "yngvem",
+      "name": "Yngve Mardal Moe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3531982?v=4",
+      "profile": "https://github.com/yngvem",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "ZacWarham",
+      "name": "Zac Warham",
+      "avatar_url": "https://avatars.githubusercontent.com/u/48937711?v=4",
+      "profile": "https://github.com/ZacWarham",
+      "contributions": [
+        "ideas",
+        "review"
+      ]
+    },
+    {
+      "login": "SanketKumarKar",
+      "name": "Sanket Kumar Kar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/197726103?v=4",
+      "profile": "https://github.com/SanketKumarKar",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "chendaniely",
+      "name": "Daniel Chen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5782147?v=4",
+      "profile": "http://chendaniely.github.io",
+      "contributions": [
+        "ideas",
+        "review"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.circleci/config.yml

@@ -5,6 +5,12 @@ jobs:
       - image: cimg/python:3.13
     steps:
       - checkout
+      - run:
+          name: Restore mtimes from git history
+          command: |
+            sudo apt-get update
+            sudo apt-get install git-restore-mtime
+            git restore-mtime
       - run:
           name: setup environment
           command: |

.github/workflows/build-book.yml

@@ -16,6 +16,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch_depth: 0
+
+      - name: Restore mtimes from git history
+        run: |
+          sudo apt-get install git-restore-mtime
+          git restore-mtime
 
       - name: Setup Python
         uses: actions/setup-python@v5

README.md

@@ -33,15 +33,26 @@ class RSSItem:
     def from_meta(cls, page_name: str, meta: dict, app: "Sphinx") -> "RSSItem":
         """Create from a page's metadata"""
         url = urljoin(app.config.html_baseurl, app.builder.get_target_uri(page_name))
+
         # purposely don't use `get` here because we want to error if these fields are absent
         return RSSItem(
             title=meta[":og:title"],
             description=meta[":og:description"],
-            date=datetime.fromisoformat(meta["date"]),
+            date=cls.get_date_updated(page_name, meta, app),
             author=meta.get(":og:author", "pyOpenSci"),
             url=url,
         )
 
+    @staticmethod
+    def get_date_updated(page_name: str, meta: dict, app: "Sphinx") -> datetime:
+        """if the page has an explicit date_updated, use that, otherwise get mtime"""
+        if 'date_updated' in meta:
+            return datetime.fromisoformat(meta['date_updated'])
+        else:
+            page_path = app.srcdir / (page_name + ".md")
+            mtime = page_path.stat().st_mtime
+            return datetime.fromtimestamp(mtime)
+
     def render(self) -> str:
         return f"""\
 <item>
@@ -61,7 +72,7 @@ class RSSFeed:
     title: str = "pyOpenSci Tutorials"
     link: str = "https://www.pyopensci.org/python-package-guide/tutorials/intro.html"
     self_link: str = "https://www.pyopensci.org/python-package-guide/tutorials.rss"
-    description: str = "Tutorials for learning python i guess!!!"
+    description: str = "A tutorial feed that lists metadata for the pyOpenSci Python packaging tutorials so we can automatically list them on our website."
     language: str = "en"
 
     def render(self) -> str:

_ext/rss.py

@@ -389,15 +389,15 @@ is currently undocumented. Thus, we don't recommend using Poetry for more comple
 :widths: 20,5,50
 :delim: "|"
 
-Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata. _NOTE: currently Poetry adds dependencies using an approach that is slightly out of alignment with current Python peps - however there is a plan to fix this in an upcoming release._ Poetry also allows you to organize dependencies in groups such as  documentation, packaging and tests.
+Add dependencies to your pyproject.toml file |✅|Poetry helps you add dependencies to your `pyproject.toml` metadata.
 Dependency specification |✅ |Poetry allows you to be specific about version of dependencies that you add to your package's pyproject.toml file. However, it's default upper bound approach can be problematic for some packages (We suggest you override the default setting when adding dependencies). Read below for more.
 Environment management |✅ | Poetry allows you to either use its built in environment or you can select the environment type that you want to use for managing your package. [Read more about its built in environment management options](https://python-poetry.org/docs/basic-usage/#using-your-virtual-environment).
 Lock files| ✅ | Poetry creates a **poetry.lock** file that you can use if you need a lock file for your build.
 Publish to PyPI and test PyPI|✅|Poetry supports publishing to both test PyPI and PyPI
 Version Control based versioning|✅ | The plugin [Poetry dynamic versioning](https://github.com/mtkennerly/poetry-dynamic-versioning) supports versioning using git tags with Poetry.
 Version bumping| ✅ | Poetry supports you bumping the version of your package using standard semantic version terms patch; minor; major
-Follows current packaging standards|✖✅|Poetry does not quite support current packaging standards for adding metadata to the **pyproject.toml** file but plans to fix this in an upcoming release.
-Install your package in editable mode|✅|Poetry supports installing your package in editable mode using `--editable`
+Follows current packaging standards|✅|Since version 2.0, Poetry supports most current project metadata standards. However, not all standards are supported, and it also supports the legacy Poetry format. Read below for more.
+Install your package in editable mode|✅|Poetry supports installing your package in editable mode.
 Build your sdist and wheel distributions|✅|Poetry will build your sdist and wheel distributions using `poetry build`
 ```
 
@@ -408,11 +408,11 @@ Build your sdist and wheel distributions|✅|Poetry will build your sdist and wh
 
 Some challenges of Poetry include:
 
-- Poetry, by default, pins dependencies using an "upper bound" limit specified with the `^` symbol by default. However, this behavior can be over-written by specifying the dependency when you use `Poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning.
-- _Minor Challenge:_ The way Poetry currently adds metadata to your pyproject.toml file does not follow current Python standards. However, this is going to be addressed with Poetry release version 2.0.
+- Poetry has its own concept of grouped dependencies (`poetry add --group=GROUP_NAME DEPENDENCY`). Dependencies added as grouped dependencies are not optional and there is no Python standard for this type of dependency. This should not be confused with "optional" dependencies (`poetry add --optional=GROUP_NAME DEPENDENCY`), which is standardised and lets you group your dependencies into several optional groups.
+- While Poetry supports "development" dependencies (i.e. dependencies you use for development but not running the code, such as `pytest`), Poetry does not yet follow the standardised format for specifying such dependencies.
+- Poetry, by default, pins dependencies using an "upper bound" limit (which is specified with the `^` symbol in the legacy format). However, this behavior can be over-written by specifying the dependency when you use `poetry add` as follows: `poetry add "requests>=2.1"` See breakout below for more discussion on issues surrounding upper-bounds pinning.
 
-Poetry is an excellent tool. Use caution when using it to pin dependencies as
-Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option.
+Poetry is a popular packaging tool and introduced many very useful features. However, if you decide to use it, then use caution when adding dependencies as Poetry's approach to pinning can be problematic for many builds. If you use Poetry, we strongly suggest that you override the default upper bound dependency option.
 
 <!--https://github.com/py-pkgs/py-pkgs/issues/95#issuecomment-1035584750
 discusses the slight differences in how poetry adds deps....-->

package-structure-code/python-package-build-tools.md

@@ -1,7 +1,6 @@
 ---
 :og:description: Learn how to add a LICENSE and CODE_OF_CONDUCT file to your Python package. This lesson covers choosing a permissive license, placing key files for visibility on GitHub and PyPI, and adopting the Contributor Covenant to support an inclusive community.
 :og:title: Add a License and Code of Conduct to your python package
-date: 1970-01-02
 ---
 
 # Add a `LICENSE` & `CODE_OF_CONDUCT` to your Python package

tutorials/add-license-coc.md

@@ -1,7 +1,6 @@
 ---
 :og:description: Learn how to create a clear, effective README file for your Python package. This lesson covers what to include, why each section matters, and how a well-structured README improves usability and discoverability on GitHub and PyPI.
 :og:title: Add a README file to your Python package
-date: 1970-01-03
 ---
 
 # Add a README file to your Python package

tutorials/add-readme.md

@@ -1,7 +1,6 @@
 ---
 :og:description: Learn how to add a command-line interface (CLI) to your Python package using the argparse library. This lesson walks you through creating a CLI entry point so users can run your package directly from the terminal.
 :og:title: Command Line Reference Guide
-date: 1970-01-04
 ---
 
 # Command Line Reference Guide

tutorials/command-line-reference.md

@@ -1,7 +1,6 @@
 ---
 :og:description: Get started with Hatch, a modern Python packaging tool. This lesson introduces Hatch’s features and shows how it simplifies environment management, project scaffolding, and building your package.
 :og:title: Get to Know Hatch
-date: 1970-01-05
 ---
 
 # Get to Know Hatch