Merge branch 'master' of https://github.com/IhorNehrutsa/simple-pid

Author: IhorNehrutsa

.github/workflows/parse_changelog.py

@@ -0,0 +1,50 @@
+import re
+import sys
+
+
+def parse_changelog(contents):
+    """
+    Parse the CHANGELOG.md and return a mapping from version to the section of the file
+    corresponding to that version.
+
+    :param contents: The contents of CHANGELOG.md.
+    """
+    result = {}
+
+    # Split the changelog into sections based on lines starting with '## '
+    for section in re.split(r'\n## ', contents):
+        # Clean up each part by removing the compare links at the bottom of the file, and by
+        # stripping whitespace
+        section = re.split(r'\[Unreleased\]', section)[0].strip()
+
+        # Add back the heading that was removed by re.split()
+        section = '## ' + section
+
+        # Parse out the version of this section. Any section which doesn't have a version (such as
+        # the '## Unreleased' section or the top introduction) are not kept.
+        version_match = re.search(r'## \[([0-9.]+)\].*', section)
+        if version_match and len(version_match.groups()) >= 1:
+            result[version_match.group(1)] = section
+
+    return result
+
+
+if __name__ == '__main__':
+    if len(sys.argv) < 4:
+        print('Error: too few arguments.')
+        sys.exit(1)
+
+    changelog_path = sys.argv[1]
+    version = sys.argv[2].removeprefix('v')
+    output_path = sys.argv[3]
+
+    with open(changelog_path, 'r') as f:
+        changelog_sections = parse_changelog(f.read())
+
+    current_section = changelog_sections.get(version)
+    if not current_section:
+        print(f'Error: could not find changelog section for version {version}')
+        sys.exit(2)
+
+    with open(output_path, 'w') as output:
+        output.write(current_section)

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+name: release
+
+on:
+  push:
+    tags:
+    - 'v*'
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Release
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: python -m pip install --upgrade pip build
+
+    - name: Build package
+      run: python -m build .
+
+    - name: Parse changelog for release notes
+      run: python .github/workflows/parse_changelog.py CHANGELOG.md ${{ github.ref_name }} body.md
+
+    - name: Publish package to PyPI
+      if: startsWith(github.ref, 'refs/tags')
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}
+
+    - name: Create GitHub release
+      uses: ncipollo/release-action@v1
+      with:
+        artifacts: "dist/*"
+        bodyFile: "body.md"
+        draft: true
+        token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/run-examples.yml

@@ -0,0 +1,46 @@
+name: examples
+
+on:
+  push:
+    # branches: [ master ]
+  pull_request:
+    # branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    name: Run examples
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install .[examples]
+        # The pyqt5 package may not be needed for non-interactive runs (such as
+        # in this CI), but may be needed as a backend for Matplotlib to run
+        # interactively.
+        # pip install pyqt5
+
+    - name: Run examples
+      run: |
+        cd examples/water_boiler/
+        NO_DISPLAY=1 python water_boiler.py
+
+    - name: Upload resulting figures
+      uses: actions/upload-artifact@v3
+      with:
+        name: result-py${{ matrix.python-version }}.png
+        path: examples/water_boiler/result-py${{ matrix.python-version }}.png

.github/workflows/run-tests.yml

@@ -0,0 +1,48 @@
+name: tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    name: Run tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "pypy-3.9"]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 mypy pytest black colorama
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+    - name: Run tests with pytest
+      run: |
+        python -m pytest -v
+
+    - name: Lint with flake8
+      run: |
+        python -m flake8 . --count --statistics
+    
+    - name: Run mypy
+      run: |
+        python -m mypy --strict simple_pid
+
+    - name: Run black
+      run: |
+        python -m black -l 100 -S --check --diff --color --exclude "docs/" .

.gitignore

@@ -9,6 +9,7 @@ build/
 .tox/
 *.pyc
 .idea/
+.vscode/
 .envrc
 build.sh
 total_downloads.py

.readthedocs.yml

@@ -0,0 +1,21 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/source/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

.travis.yml

@@ -7,17 +7,52 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [2.0.0] - 2023-04-28
+
+### Added
+
+- Ability to override the time function by setting PID.time_fn to whichever function to use
+- Black is now run in CI to detect formatting problems
+- Project is now defined by a pyproject.toml file instead of the old setup.py. The setup.cfg file remains for flake8 configuration for now.
+- Ability to give the PID a starting guess for its output, when you start controlling a system that is already at the setpoint and don't want the PID to start outputting 0
+- Option for specifying differential_on_measurement, to choose between calculating the derivative term on the input (default) or on the error (classic PID)
+
+### Changed
+
+- Rename the module `PID` to `pid` to avoid the shadowing from the `PID` class
+- CI migrated from Travis to GitHub Actions
+- The [documentation](https://simple-pid.readthedocs.io/) has gotten an overhaul and a new look. Much of the detailed documentation in README.md has been moved to a dedicated user guide.
+
+### Fixed
+
+- Fix mypy issue by explicitly exporting `PID`
+- Remove duplicated definition of `output_limits` in type stubs
+
+### Deprecated
+
+- Official support for Python 2 is dropped. While the code will likely keep working in Python 2 going forward, it's no longer tested in CI and no guarantees are given.
+
+## [1.0.1] - 2021-04-11
+
+### Fixed
+
+- Added type information for public instance variables to typing stub
+
+## [1.0.0] - 2021-03-20
+
 ### Added
 
-- Function to map the erro value, now is possibly to clip the error value, i.e., [-pi, pi[
+- Function to map the error value to a different domain
 
 - Typing information through a stub file so that users of the library can use e.g.
   [mypy](https://github.com/python/mypy) to type check their code
 
 - This project now uses the [Black code style](https://github.com/psf/black)
 
-- The PID class now has a \_\_repr\_\_() method, meaning that objects of this type can be printed
+- The PID class now has a `__repr__()` method, meaning that objects of this type can be printed
   directly for use during development
+  
+- MANIFEST.in file to ensure all necessary files are included in the source distribution
 
 ### Fixed
 
@@ -79,7 +114,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Initial implementation
 
-[Unreleased]: https://github.com/m-lundberg/simple-pid/compare/v0.2.4...HEAD
+[Unreleased]: https://github.com/m-lundberg/simple-pid/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/m-lundberg/simple-pid/compare/v1.0.1...v2.0.0
+[1.0.1]: https://github.com/m-lundberg/simple-pid/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/m-lundberg/simple-pid/compare/v0.2.4...v1.0.0
 [0.2.4]: https://github.com/m-lundberg/simple-pid/compare/v0.2.3...v0.2.4
 [0.2.3]: https://github.com/m-lundberg/simple-pid/compare/v0.2.2...v0.2.3
 [0.2.2]: https://github.com/m-lundberg/simple-pid/compare/v0.2.1...v0.2.2

CHANGELOG.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Martin Lundberg
+Copyright (c) 2018-2023 Martin Lundberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -0,0 +1,13 @@
+include CHANGELOG.md
+include LICENSE.md
+include README.md
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst *.md conf.py requirements.txt
+recursive-include examples *.md *.txt *.py
+recursive-include tests *.py
+
+include simple_pid/*.pyi
+include simple_pid/py.typed