release v1.5.2

.github/workflows/upload_release.yml

@@ -12,16 +12,13 @@ on:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-
   upload:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v4
-
       # Sets up python3
       - uses: actions/setup-python@v5
         with:
@@ -32,20 +29,22 @@ jobs:
           # Upgrade pip
           python3 -m pip install --upgrade pip
           # Install twine
-          python3 -m pip install setuptools wheel twine
-
+          python3 -m pip install build setuptools wheel twine
       # Upload to PyPI
       - name: Build and Upload to PyPI
         run: |
-          python3 setup.py sdist --formats=zip
-          twine check dist/* --strict
+          python3 -m build
+          python3 -m twine check dist/* --strict
           python3 -m twine upload dist/*
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.PYPI }}
           TWINE_REPOSITORY: pypi
-
-      - name: Sleep for 150s to make release available
+      - name: Sleep for 300s to make release available
         uses: juliangruber/sleep-action@v2
         with:
           time: 300s
+      - name: Install simbench from PyPI
+        run: |
+          python3 -m pip install simbench
+          python3 -c "import simbench; print(simbench.__version__)"

.readthedocs.yml

@@ -1,9 +1,18 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 version: 2
 
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: doc/conf.py
+
 python:
-    version: 3.8
     install:
        - method: pip
          path: .
          extra_requirements:
-            - docs,plotting
+            - docs,plotting

CHANGELOG.rst

@@ -1,9 +1,19 @@
 Change Log
 =============
 
+[1.5.2] - 2024-04-09
+----------------------
+- [CHANGED] readded copyright notice to setup.py and updated date
+- [CHANGED] added prune to MANIFEST.in to exclude doc and tutorials from wheel builds
+- [CHANGED] removed gitlab ci files from MANIFEST.in to keep them out of wheel builds
+- [CHANGED] updated pyproject.toml to fix build issues
+- [CHANGED] updated upload_release.yml to not call setup.py anymore (see https://packaging.python.org/en/latest/discussions/setup-py-deprecated/)
+- [CHANGED] updated upload_release.yml to build and upload src dist as .tar.gz and .whl
+- [CHANGED] updated upload_release.yml to install from PyPI and test the installed package
+
 [1.5.1] - 2024-04-08
 ----------------------
-[FIXED] spelling mistake in pyproject.toml
+- [FIXED] spelling mistake in pyproject.toml
 
 [1.5.0] - 2024-04-08
 ----------------------

MANIFEST.in

@@ -1,4 +1,8 @@
-include LICENSE AUTHORS README.rst CHANGELOG.rst .github/**/*.yml
+include LICENSE AUTHORS README.rst CHANGELOG.rst
+
 global-include *.csv
 global-include *.json
 global-include *.txt
+
+prune doc*
+prune tutorials*

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simbench"
-version = "1.5.1" # File format version '__format_version__' is tracked in _version.py
+version = "1.5.2"
 authors = [
     { name = "Steffen Meinecke", email = "[email protected]" }
 ]
@@ -65,8 +65,8 @@ all = [
 ]
 # "shapely", "pyproj", "fiona" are dependencies of geopandas and should be already available
 
-[tool.setuptools.packages.find]
-where = ["simbench"]
+[tool.setuptools.packages]
+find = {}
 
 [tool.pytest.ini_options]
 addopts = ["--strict-markers"]

setup.py

@@ -1,3 +1,9 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2019-2024 by University of Kassel, Tu Dortmund, RWTH Aachen University and Fraunhofer
+# Institute for Energy Economics and Energy System Technology (IEE) Kassel and individual
+# contributors (see AUTHORS file for details). All rights reserved.
+
 from setuptools import setup
 
 setup()