v1.0.0 (#2)

christophfink · web-flow · commit 78dda84b609a · 2025-04-25T14:30:25.000+02:00
* update github action runners

* Include tests in source packages

* prepare v1.0.0

* typo

* linted

* coverage

* coverage

* remove sphinxcontrib-images

* typo

* add some more tests

* linted
diff --git a/.github/workflows/build-merged-pull-requests.yml b/.github/workflows/build-merged-pull-requests.yml
diff --git a/.github/workflows/lint-test-upon-push.yml b/.github/workflows/lint-test-upon-push.yml
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,20 @@
+# vim: set tabstop=2 softtabstop=2 shiftwidth=2 expandtab:
+
+name: Lint code
+on:
+  workflow_call:
+
+jobs:
+  lint:
+    name: Linting code
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: pip
+      - run: python -m pip install black flake8 pydocstyle
+      - run: python -m black --check .
+      - run: python -m flake8 .
+      - run: python -m pydocstyle .
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,27 +1,44 @@
 # vim: set tabstop=2 softtabstop=2 shiftwidth=2 expandtab:
 
-name: Create a release and deploy to PyPi whenever a protected tag (v0.0.0) is created
+name: Create a release and deploy to PyPi
 
 on:
   push:
     tags:
       - v*.*.*
+      - v*.*.*.dev*
+      - v*.*.*.post*
 
 jobs:
-  build:
-    name: Build package
-    uses: ./.github/workflows/build-merged-pull-requests.yml
+  test:
+    uses: ./.github/workflows/test.yml
     secrets: inherit
 
+  build:
+    name: Build wheel
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: "pip"
+      - run: python -m pip install build
+      - run: python -m build .
+      - uses: actions/upload-artifact@v4
+        with:
+          name: package
+          path: dist/*.*
+
   merge-into-stable:
     name: Update stable branch to point to this release
     runs-on: ubuntu-latest
     needs: [build]
     if: "!contains(github.ref, 'dev')"
     permissions: write-all
     steps:
-      - name: Clone repository, check-out stable
-        uses: actions/checkout@v4.1.1
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: stable
@@ -32,21 +49,22 @@ jobs:
           git push
 
   deploy:
-    name: Upload built package to PyPi
+    name: Upload built wheel and source package to PyPi
     runs-on: ubuntu-latest
     needs: [build]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/cartogram
+    permissions:
+      id-token: write
     steps:
-      - name: Download built artifacts
-        uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: dist/
-      - name: Upload package to PyPi
-        uses: pypa/gh-action-pypi-publish@release/v1.9
+      - uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
-          skip_existing: true
+          skip-existing: true
 
   release:
     name: Create a new release
@@ -56,13 +74,11 @@ jobs:
     permissions:
       contents: write
     steps:
-      - name: Download built artifacts
-        uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: dist/
-      - name: Create release and upload package
-        uses: softprops/action-gh-release@v2
+      - uses: softprops/action-gh-release@v2
         with:
           files: dist/*
 
@@ -74,13 +90,11 @@ jobs:
     permissions:
       contents: write
     steps:
-      - name: Download built artifacts
-        uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
           name: package
           path: dist/
-      - name: Create release and upload package
-        uses: softprops/action-gh-release@v2
+      - uses: softprops/action-gh-release@v2
         with:
           files: dist/*
           prerelease: true
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,52 @@
+# vim: set tabstop=2 softtabstop=2 shiftwidth=2 expandtab:
+
+name: Unit tests
+on:
+  pull_request:
+  workflow_call:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+    secrets: inherit
+
+  test:
+    name: Run tests (${{ matrix.os }}, Python ${{ matrix.python_version }}
+    needs: lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: 
+          - ubuntu-latest
+          - windows-latest
+          - macos-latest
+        python_version:
+          - '3.13'
+          - '3.12'
+          - '3.11'
+          - '3.10'
+
+    steps:
+      -  uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '${{matrix.python_version}}'
+          cache: 'pip'
+
+      - run: python -m pip install --prefer-binary .[tests]
+
+      - run: python -m pytest
+
+      - uses: codecov/codecov-action@v4
+        with:
+          fail_ci_if_error: true
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+- **1.0.0** (2025-04-25):
+    - migrated to PyPi Trusted Publishing
+    - included tests in source wheels
+
 - **0.0.2** (2024-07-15):
     - added documentation
 
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,3 @@
+recursive-include tests *.py
+recursive-include tests/data *
+global-exclude *.pyc
diff --git a/docs/_extensions/bibliography_as_sphinxdesign_cards/__init__.py b/docs/_extensions/bibliography_as_sphinxdesign_cards/__init__.py
@@ -59,15 +59,19 @@
 class CitationsToSphinxDesignCardsTransformer(
     sphinx.transforms.post_transforms.SphinxPostTransform
 ):
+    """Modify the bibliography entries created by sphinxcontrib.bibtex to be sphinx-design cards."""
+
     default_priority = (
         198  # before anything from sphinx_design, but after sphinxcontrib.bibtex
     )
 
     def apply(self, **kwargs):
+        """Apply the transformation to all relevant nodes."""
         for node in self.document.findall(docutils.nodes.citation):
             self.handle(node)
 
     def handle(self, node):
+        """Modify a single node."""
         new_node = self._create_empty_sdcard_container()
         for attribute in ["backrefs", "docname", "ids"]:
             new_node[attribute] = node[attribute]
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,3 +1,7 @@
+#!/bin/env python3
+
+"""Define how the documentation is compiled."""
+
 # Configuration file for the Sphinx documentation builder.
 #
 # For the full list of built-in configuration values, see the documentation:
@@ -41,7 +45,6 @@
     "sphinx.ext.napoleon",
     "sphinx_design",
     "sphinxcontrib.bibtex",
-    "sphinxcontrib.images",
 ]
 
 templates_path = ["_templates"]
diff --git a/docs/index.md b/docs/index.md
@@ -1,13 +1,22 @@
 # *python-cartogram* - compute continuous cartograms
 
 
-:::{thumbnail} _static/images/Austria_PopulationCartogram_NUTS2_20170101.svg
+:::{figure} _static/images/Austria_PopulationCartogram_NUTS2_20170101.svg
 :alt: A map showing the nine federal provinces of Austria, distorted in a way that their relative areas relate to their population numbers.
-:title: The nine federal provinces of Austria, distorted so their area sizes match their population numbers
-:show_caption: 1
 :class: align-default
+
+The nine federal provinces of Austria, distorted so their area sizes match their population numbers
 :::
 
+% -> https://github.com/sphinx-contrib/images/pull/39#issuecomment-2258779386
+
+% :::{thumbnail} _static/images/Austria_PopulationCartogram_NUTS2_20170101.svg
+% :alt: A map showing the nine federal provinces of Austria, distorted in a way that their relative areas relate to their population numbers.
+% :title: The nine federal provinces of Austria, distorted so their area sizes match their population numbers
+% :show_caption: 1
+% :class: align-default
+% :::
+
 
 **python-cartogram** is a Python package that can be used to compute continuous
 cartograms. These map-like cartographic visualisations, also known as
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,7 +18,7 @@ dependencies = [
     "pandas",
     "shapely"
 ]
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 
 classifiers = [ 
     "Programming Language :: Python :: 3",
@@ -35,7 +35,7 @@ docs = ["folium", "GitPython", "jupyterlab_myst", "mapclassify", "matplotlib",
         "myst-nb", "nbsphinx", "pybtex-apa7-style", "sphinx", 
         "sphinx-book-theme", "sphinx-design", "sphinxcontrib-bibtex",
         "sphinxcontrib-images", "xyzservices"]
-tests = ["pytest", "pytest-asyncio", "pytest-lazy-fixtures"]
+tests = ["pytest", "pytest-cov", "pytest-lazy-fixtures"]
 
 [project.urls]
 Documentation = "https://python-cartogram.readthedocs.org/"
@@ -47,9 +47,9 @@ Repository = "https://github.com/austromorph/python-cartogram"
 omit = ["tests/*", ".virtualenv/**/*"]
 
 [tool.pytest.ini_options]
-#addopts = "-p no:faulthandler -r s"
+addopts = "--cov=cartogram --cov-report term-missing --cov-report xml"
+pythonpath = ["src"]
 testpaths = ["tests"]
-asyncio_mode = "auto"
 
 [tool.setuptools.dynamic]
 version = {attr = "cartogram.__version__"}
diff --git a/src/cartogram/__init__.py b/src/cartogram/__init__.py
@@ -2,7 +2,7 @@
 
 """Compute continuous cartograms."""
 
-__version__ = "0.0.2"
+__version__ = "1.0.0"
 
 from .cartogram import Cartogram
 
diff --git a/src/cartogram/cartogram.py b/src/cartogram/cartogram.py
diff --git a/tests/conftest.py b/tests/conftest.py
diff --git a/tests/test_cartogram.py b/tests/test_cartogram.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+recursive-include tests *.py`
	`2`	`+recursive-include tests/data *`
	`3`	`+global-exclude *.pyc`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,7 @@`
	`1`	`+#!/bin/env python3`
	`2`	`+`
	`3`	`+"""Define how the documentation is compiled."""`
	`4`	`+`
`1`	`5`	`# Configuration file for the Sphinx documentation builder.`
`2`	`6`	`#`
`3`	`7`	`# For the full list of built-in configuration values, see the documentation:`
`@@ -41,7 +45,6 @@`
`41`	`45`	`"sphinx.ext.napoleon",`
`42`	`46`	`"sphinx_design",`
`43`	`47`	`"sphinxcontrib.bibtex",`
`44`		`- "sphinxcontrib.images",`
`45`	`48`	`]`
`46`	`49`
`47`	`50`	`templates_path = ["_templates"]`