Skip to content

Commit

Permalink
Python: Update of version range to 3.10-3.13 #25
Browse files Browse the repository at this point in the history
  • Loading branch information
detlefarend committed Dec 3, 2024
1 parent 226d6df commit 661d820
Show file tree
Hide file tree
Showing 8 changed files with 60 additions and 45 deletions.
46 changes: 24 additions & 22 deletions .github/ISSUE_TEMPLATE/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,42 @@ name: Release-Checklist
about: List of all necessary steps before, during and after a release.
title: Release vX.Y.Z
labels: admin
assignees: detlefarend
assignees: detlefarend, steveyuwono

---

Release Checklist
-----------------
-------------------

**1 Preparation**
- [ ] 1.1 Inform the team on slack to stop merging to main
- [ ] 1.2 Rename label "next release" to "vX.Y.Z"
- [ ] 1.3 Create new label "next release"
- [ ] 1.4 Relabel all open issues of release "vX.Y.Z" to "next release"
- [ ] 1.5 Update version in ./setup.py
- [ ] 1.6 Update version in ./src/setup.py
- [ ] 1.7 Update version in ./src/conda/meta.yaml
- [ ] 1.8 Check documentation on RTD
- [ ] 1.8.1 All class diagrams there?
- [ ] 1.8.2 All auto-generated code descriptions there?
- [ ] 1.8.3 Logo there?
- [ ] 1.9 Check action log for errors

- [ ] 1.2 Create a new version number in project custom field 'version'
- [ ] 1.3 Assign new version number to all related issues and remove label 'next release'
- [ ] 1.4 Updates in branch main
- [ ] 1.4.1 Update version in ./setup.cfg
- [ ] 1.4.2 Update version in ./src/setup.py
- [ ] 1.4.3 Update version in ./doc/rtd/conf.py
- [ ] 1.4.4 Update ./CITATION.cff (see [Zenodo recommendation](https://zenodo.org/account/settings/github/repository/fhswf/MLPro-Int-River))
- [ ] 1.4.5 Update ./requirements.txt
- [ ] 1.4.6 Build and check RTD documentation
- [ ] 1.4.6.1 All class diagrams there?
- [ ] 1.4.6.2 All auto-generated code descriptions there?
- [ ] 1.4.6.3 Logo there?
- [ ] 1.4.7 Commit all changes and observe the action log

**2 Release**
- [ ] 2.1 Create a new release
- [ ] 2.2 Generate/beautify release notes
- [ ] 2.3 Commit new release
- [ ] 2.1 Create a new [release](https://github.com/fhswf/MLPro-Int-River/releases)
- [ ] 2.2 Generate/complete release notes
- [ ] 2.3 Commit new release and observe the action log
- [ ] 2.4 Activate new release in [ReadTheDocs](https://readthedocs.org) as user **mlpro-admin**


**3 Postprocessing**
- [ ] 3.1 Check documentation on RTD
- [ ] 3.1 Check the [RTD documentation](https://mlpro-int-river.readthedocs.io)
- [ ] 3.1.1 All class diagrams there?
- [ ] 3.1.2 All auto-generated code descriptions there?
- [ ] 3.1.3 Logo there?
- [ ] 3.2 Check entry on PyPI
- [ ] 3.3 Check entry on Anaconda
- [ ] 3.4 Inform the team on slack
- [ ] 3.5 Significant progress? Write a project log entry on ResearchGate.
- [ ] 3.2 Check [MLPro-Int-River in PyPI](https://pypi.org/project/mlpro-int-river/)
- [ ] 3.3 Check [MLPro-Int-River in Zenodo](https://zenodo.org/account/settings/github/repository/fhswf/MLPro-Int-River)
- [ ] 3.4 Update all open branches from main
- [ ] 3.5 Inform the team on slack
16 changes: 12 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
## -------------------------------------------------------------------------------------------------
## -- Project : MLPro - The integrative middleware framework for standardized machine learning
## -- Extension : MLPro-Int-scikit-learn - Integration of scikit-learn into MLPro
## -- Workflow : ci.yml
## -------------------------------------------------------------------------------------------------
## -- History :
## -- yyyy-mm-dd Ver. Auth. Description
## -- 2024 1.0.0 MRD Creation
## -- 2024-11-28 1.1.0 DA Updated the version range for Python to 3.10 - 3.13
## -------------------------------------------------------------------------------------------------

name: Unit Tests

Expand Down Expand Up @@ -46,7 +54,7 @@ jobs:
if: needs.deps_gen.outputs.trigger_build == 'true'
strategy:
matrix:
python-version: ['3.9', '3.10', '3.11']
python-version: ['3.10', '3.11', '3.12', '3.13']

steps:
- name: Checkout Codes
Expand Down Expand Up @@ -82,7 +90,7 @@ jobs:
if: needs.deps_gen.outputs.trigger_build == 'true'
strategy:
matrix:
python-version: ['3.10']
python-version: ['3.11']

steps:
- name: Checkout Codes
Expand Down
24 changes: 16 additions & 8 deletions .github/workflows/pypi_deploy.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
## -------------------------------------------------------------------------------------------------
## -- Project : MLPro - The integrative middleware framework for standardized machine learning
## -- Extension : MLPro-Int-River - Integration of River into MLPro
## -- Workflow : pypi_deploy.yml
## -------------------------------------------------------------------------------------------------
## -- History :
## -- yyyy-mm-dd Ver. Auth. Description
## -- 2024 1.0.0 MRD Creation
## -- 2024-12-03 1.1.0 DA Updated the version for Python to 3.10
## -------------------------------------------------------------------------------------------------

name: Deployment PyPI

on:
release:
types: [published]

workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.9]

steps:
- name: Checkout Codes
uses: actions/checkout@v2
with:
ref: ${{ github.head_ref }}
- name: Set up Python ${{ matrix.python-version }}
- name: Set up Python 3.10
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
python-version: '3.10'
- name: Install pypa/build
run: >-
python -m
Expand All @@ -36,7 +44,7 @@ jobs:
--wheel
--outdir dist/
- name: Publish distribution to PyPI
if: startsWith(github.ref, 'refs/tags')
# if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@master
with:
password: ${{ secrets.PYPI_API_TOKEN }}
5 changes: 1 addition & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
[![CI](https://github.com/fhswf/MLPro-Int-River/actions/workflows/ci.yml/badge.svg)](https://github.com/fhswf/MLPro-Int-River/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/mlpro-int-river/badge/?version=latest)](https://mlpro-int-river.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/mlpro-int-river.svg)](https://badge.fury.io/py/mlpro-int-river)
<!---
[![Anaconda-Version Badge](https://anaconda.org/mlpro-int-river/mlpro-int-river/badges/version.svg)](https://anaconda.org/mlpro-int-river/mlpro)
[![Anaconda-Downloads Badge](https://img.shields.io/conda/dn/mlpro-int-river/mlpro-int-river?color=green&label=Anaconda.org%20Total%20downloads&style=flat-square)](https://anaconda.org/mlpro-int-river/mlpro-int-river)
--->
[![PyPI Total Downloads](https://static.pepy.tech/personalized-badge/mlpro-int-river?period=total&units=international_system&left_color=blue&right_color=orange&left_text=PyPI%20Total%20Downloads)](https://pepy.tech/project/mlpro-int-river)
[![PyPI Last Month Downloads](https://static.pepy.tech/personalized-badge/mlpro-int-river?period=month&units=international_system&left_color=blue&right_color=orange&left_text=PyPI%20Last%20Month%20Downloads)](https://pepy.tech/project/mlpro-int-river)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11130004.svg)](https://doi.org/10.5281/zenodo.11130004)


<img src="https://github.com/fhswf/MLPro-Int-River/blob/main/doc/logo/original/logo.png?raw=True" align="right" width="40%"/>
Expand Down
2 changes: 1 addition & 1 deletion doc/rtd/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Detlef Arend, Steve Yuwono, Laxmikant Shrikant Baheti et al'

# The full version, including alpha/beta/rc tags
release = '0.2.0'
release = '0.3.0'


# -- General configuration ---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
mlpro[full]>=1.9.0
mlpro[full]>=1.9.4
river>=0.21.0
6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[metadata]
name = mlpro-int-river
version = 0.2.0
version = 0.3.0
author = MLPro Team
author_email = [email protected]
description = MLPro: Integration River
Expand All @@ -18,13 +18,13 @@ classifiers =
package_dir =
= src
packages = find:
python_requires = >=3.9
python_requires = >=3.10
include_package_data = True

[options.packages.find]
where = src

[options.extras_require]
full =
mlpro[full]>=1.9.0
mlpro[full]>=1.9.4
river>=0.21.0
4 changes: 2 additions & 2 deletions src/setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@


setup(name='mlpro-int-river',
version='0.2.0',
version='0.3.0',
description='MLPro: Integration River',
author='MLPro Team',
author_mail='[email protected]',
Expand All @@ -12,7 +12,7 @@
# Package dependencies for full installation
extras_require={
"full": [
"mlpro[full]>=1.9.0",
"mlpro[full]>=1.9.4",
"river>=0.21.0"
],
},
Expand Down

0 comments on commit 661d820

Please sign in to comment.