pysdccc 0.1.0__tar.gz

pysdccc-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,14 @@
+<!--- Provide a general summary of your changes in the title above -->
+<!--- Link the corresponding issues after you created the pull request -->
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+- [ ] I have updated the [changelog](../CHANGELOG.md) accordingly.
+- [ ] I have added tests to cover my changes.

pysdccc-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,137 @@
+on:
+  workflow_call:
+  pull_request:
+    types: [ opened, synchronize, reopened, ready_for_review ]
+  push:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install pre-commit
+        run: uv tool install pre-commit --with pre-commit-uv --force-reinstall
+
+      - name: Run pre-commit
+        run: uvx pre-commit run --all-files
+
+  build:
+    needs: lint
+    name: Build
+    runs-on: ubuntu-latest
+    outputs:
+      WHL: ${{ steps.filenames.outputs.WHL }}
+      TARGZ: ${{ steps.filenames.outputs.TARGZ }}
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - run: uv venv
+
+      - name: Setup hatch
+        run: uv pip install hatch
+
+      - name: Set new version
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          uv run hatch version ${GITHUB_REF/refs\/tags\/v/}
+
+      - name: Build package
+        run: uv build
+
+      - name: Set filenames in output
+        id: filenames
+        run: |
+          echo WHL=$(echo dist/*.whl) >> $GITHUB_OUTPUT
+          echo TARGZ=$(echo dist/*.tar.gz) >> $GITHUB_OUTPUT
+
+      - name: Archive package
+        uses: actions/upload-artifact@v4
+        with:
+          name: distributions
+          path: dist
+          retention-days: 5
+
+  tests:
+    needs: build
+    name: Tests
+
+    strategy:
+      matrix:
+        python-version: [ "3.11", "3.12", "3.13" ]
+        os: [ ubuntu-latest, windows-latest ]
+        distribution: [ "${{ needs.build.outputs.WHL }}",
+                        "${{ needs.build.outputs.TARGZ }}" ]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: uv venv
+
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist
+
+      - name: Install package
+        run: uv pip install ${{ matrix.distribution }}
+
+      - name: Install test dependencies
+        run: uv sync --group test --frozen
+
+      - name: Detect suffix on ubuntu
+        if: ${{ matrix.os == 'ubuntu-latest' }}
+        run: |
+          echo SUFFIX=$(python -c "import pathlib;p=pathlib.Path('${{ matrix.distribution }}');print('whl') if p.suffix=='.whl' else print('tar_gz')") >> $GITHUB_ENV
+
+      - name: Detect suffix on windows
+        if: ${{ matrix.os == 'windows-latest' }}
+        # https://github.com/actions/runner-images/issues/5251#issuecomment-1071030822
+        run: |
+          echo SUFFIX=$(python -c "import pathlib;p=pathlib.Path('${{ matrix.distribution }}');print('whl') if p.suffix=='.whl' else print('tar_gz')") | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
+
+      - name: Run pytest
+        run: >-
+          uv run pytest
+          --html=pytest_reports/unittest_report_${{ matrix.os }}_py${{ matrix.python-version }}_${{ env.SUFFIX }}.html
+          --self-contained-html
+          --log-file pytest_${{ matrix.os }}_py${{ matrix.python-version }}_${{ env.SUFFIX }}.log
+          --cov=src --cov-branch --cov-report=xml
+
+      - name: Archive test result
+        uses: actions/upload-artifact@v4
+        if: success() || failure()  # upload artifacts also if test stage failed
+        with:
+          name: unittest_reports-${{ matrix.os }}-py${{ matrix.python-version }}-${{ env.SUFFIX }}
+          path: pytest_reports/unittest_report_${{ matrix.os }}_py${{ matrix.python-version }}_${{ env.SUFFIX }}.html
+          retention-days: 5
+
+      - name: Archive test log
+        uses: actions/upload-artifact@v4
+        if: success() || failure()  # upload artifacts also if test stage failed
+        with:
+          name: pytest_logs-${{ matrix.os }}-py${{ matrix.python-version }}-${{ env.SUFFIX }}
+          path: pytest_${{ matrix.os }}_py${{ matrix.python-version }}_${{ env.SUFFIX }}.log
+          retention-days: 5
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

pysdccc-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,88 @@
+name: Publish package
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+" # normal release
+      - "v[0-9]+.[0-9]+.[0-9]+rc[0-9]+" # release candidate
+      - "v[0-9]+.[0-9]+.[0-9]+[ab][0-9]+" # alpha or beta release
+
+jobs:
+  build:
+    uses: ./.github/workflows/build.yml
+
+  upload:
+    name: Upload
+    runs-on: ubuntu-latest
+    needs: build
+    outputs:
+      DO_GITHUB_RELEASE: ${{ steps.detect-release.outputs.DO_GITHUB_RELEASE }}
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pysdccc
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist/
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Detect release version
+        id: detect-release
+        run: |
+          do_github_release=$((echo "${GITHUB_REF}" | grep -Eq "^refs\/tags\/v[0-9]+\.[0-9]+\.[0-9]+(rc[0-9]+)?$") && echo 1 || echo 0)
+          echo DO_GITHUB_RELEASE=$do_github_release >> $GITHUB_OUTPUT
+          echo DO_GITHUB_RELEASE=$do_github_release
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    needs: upload
+    if: needs.upload.outputs.DO_GITHUB_RELEASE == '1'
+    permissions:
+      contents: write
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v4
+
+      - name: Download Build
+        uses: actions/download-artifact@v4
+        with:
+          name: distributions
+          path: dist
+
+      - name: Download unittest reports
+        uses: actions/download-artifact@v4
+        with:
+          pattern: unittest_reports-*
+          path: pytest_reports/
+
+      - name: Zip unittest reports
+        uses: vimtor/action-zip@v1
+        with:
+          files: pytest_reports/
+          dest: pytest_reports/test_reports.zip
+
+      - name: Detect prerelease
+        id: detect-prerelease
+        run: |
+          do_prerelease=$((echo "${GITHUB_REF}" | grep -Eq "^refs\/tags\/v[0-9]+\.[0-9]+\.[0-9]+rc[0-9]+$") && echo 1 || echo 0)
+          echo DO_PRERELEASE=$do_prerelease >> $GITHUB_ENV
+          echo DO_PRERELEASE=$do_prerelease
+
+      - name: Attach artifacts to github release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            CHANGELOG.md
+            dist/*
+            pytest_reports/test_reports.zip
+          prerelease: ${{ env.DO_PRERELEASE == '1' }}
+          body_path: CHANGELOG.md

pysdccc-0.1.0/.gitignore

@@ -0,0 +1,164 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# exclude sdccc binaries downloaded for local development
+src/pysdccc/_sdccc/

pysdccc-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,58 @@
+# This is the configuration file for pre-commit (https://pre-commit.com/).
+# To use:
+# * Install pre-commit (https://github.com/tox-dev/pre-commit-uv)
+# * Copy this file as ".pre-commit-config.yaml"
+# * Run "pre-commit install".
+repos:
+  - repo: https://github.com/adrienverge/yamllint
+    rev: v1.35.1
+    hooks:
+      - id: yamllint
+        args: ['-d {extends: relaxed, rules: {line-length: disable, new-lines: { type: unix }}}', '-s']
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [ "--fix=lf" ]
+      - id: trailing-whitespace
+      - id: check-executables-have-shebangs
+      - id: check-illegal-windows-names
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.6.3
+    hooks:
+      # Update the uv lockfile
+      - id: uv-lock
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.7
+    hooks:
+      - id: ruff
+        args: [--fix, --show-fixes]
+      - id: ruff-format
+
+  - repo: https://github.com/RobertCraigie/pyright-python
+    rev: v1.1.394
+    hooks:
+      - id: pyright
+        additional_dependencies:
+          - click >= 8
+          - pytest >= 8
+          - lxml-stubs >= 0.5.1
+          - junitparser >= 3.1.2
+          - httpx >= 0.28.0
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.10.0
+    hooks:
+      - id: python-check-blanket-noqa
+      - id: python-check-blanket-type-ignore
+      - id: python-check-mock-methods
+      - id: python-no-eval
+      - id: python-no-log-warn
+      - id: python-use-type-annotations

pysdccc-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

pysdccc-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to the pysdccc module will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2025-05-16
+
+### Added
+
+- initial code

pysdccc-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,145 @@
+# How to contribute to Drägerwerk pysdccc
+
+Welcome to our project. We are glad you want to improve this open source library. We at Dräger want to create technology
+for life and help to create a better future 🚀.
+
+If you provide Markdown documents, issues, pull request or discussions we strongly encourage you
+to [format your text](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
+as it greatly helps to read and to understand your provided information.
+
+For this open source project
+the [Contributor License Agreement](https://github.com/Draegerwerk/sdc11073/blob/master/Contributor_License_Agreement.md)
+governs
+all relevant activities and your contributions. By contributing to the project you agree to be bound by this Agreement
+and to license your work accordingly.
+
+## How to set up the project for development
+
+- As we restricted pushing directly to one of pysdccc's branches, you have
+  to [create a fork](https://github.com/Draegerwerk/pysdccc/fork) where you can push your changes before creating a
+  pull request.
+- Install the dependencies, e.g. with `uv sync --dev --all-extras`.
+- Install [tox-uv](https://github.com/tox-dev/tox-uv) if you use [uv](https://docs.astral.sh/uv/) or [tox](https://pypi.org/project/tox/) if you don't
+- Before making any commits, ensure
+  you [sign your commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
+
+## Get support
+
+By following these guidelines, you help us to address your concerns more efficiently.
+
+### Create an issue
+
+If you encounter any problems or have suggestions for improvements, we encourage you to create
+an [issue](https://github.com/Draegerwerk/pysdccc/issues/new/).
+
+Here's how you can do it effectively:
+
+1. **Search Existing Issues**: Before creating a new issue, please search the existing issues to avoid duplicates. If
+   you find an issue that addresses your problem or suggestion, feel free to add a comment to it.
+
+2. **Provide Detailed Information**: Give a concise and informative title and fill out the rest of the form to your best
+   knowledge. The more information you provide the better we can help you.
+
+3. **Submit the Issue**: Once you've filled out all the necessary information, submit the issue.
+
+## Coding Standards / Style Guide
+
+This section outlines the coding standards and style guidelines for our project. Adhering to these guidelines ensures
+code readability, maintainability, and consistency across the project. It's crucial for all contributors to follow these
+practices to facilitate collaboration and code quality.
+
+### General Principles
+
+- **Readability**: Code should be written to be readable by humans. Clarity is preferred over cleverness.
+- **Consistency**: Follow the established patterns and practices in the project.
+- **Simplicity**: Strive for simplicity in your code. Avoid unnecessary complexity.
+
+### Formatting / Static Code Analysis
+
+- Use [ruff](https://docs.astral.sh/ruff/) to ensure your code adheres to our coding standards.
+- Use [pyright](https://github.com/microsoft/pyright) for type checking. Ensure your code is typed and passes pyright checks.
+
+Checkout our [`pyproject.toml`](https://github.com/Draegerwerk/pysdccc/blob/main/pyproject.toml) for more details.
+
+### Naming Conventions
+
+- **Modules**: Use short, lowercase names. If necessary, use underscores to improve readability (e.g., `my_module`).
+- **Classes**: Use the CapWords convention (e.g., `MyClass`).
+- **Functions and Variables**: Use lowercase with words separated by underscores (e.g., `my_function`).
+- **Constants**: Use all uppercase with words separated by underscores (e.g., `MY_CONSTANT`).
+
+### Comments
+
+- Use inline comments sparingly and ensure they are relevant and add value.
+- Write docstrings for all public modules, functions, classes, and methods. Follow
+  the [reStructuredText](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html) format.
+
+## Testing / Coverage
+
+We take testing seriously to ensure the reliability and stability of our project. Here's how you can contribute to
+testing:
+
+### Running Tests
+
+- To run the existing test suite, execute `pytest` at the root of the project. This will run all tests and display a
+  report.
+- Ensure that all tests pass before submitting a pull request.
+
+### Writing Tests
+
+- When adding new features or fixing bugs, write tests that cover your changes. We strive for comprehensive test
+  coverage to maintain code quality.
+- Follow our project's conventions for test structure and naming. Tests should be placed in the `tests` directory.
+- Use descriptive test function names that clearly state what is being tested.
+
+By following these guidelines, you help ensure that our project remains stable, reliable, and easy to maintain. Thank
+you for contributing to our tests!
+
+## How to create a pull request
+
+Creating a pull request is a critical step in contributing to our project. Here's how to do it effectively:
+
+1. **Ensure Your Branch is Up-to-Date**: Before starting, make sure your branch is up-to-date with the branch you're
+   planning to merge into.
+
+2. **Check Your Changes**:
+    - Run `tox` to check your changes. Ensure all tests pass and the code is formatted correctly.
+
+3. **Commit Your Changes**: Commit your changes with clear, descriptive commit messages.
+
+4. **Push to Your Fork**: Push your changes to your fork of the repository.
+
+5. **Create the Pull Request**:
+    - Navigate to the original repository you forked from.
+    - Click on the "Pull requests" tab and then the "New pull request" button.
+    - Choose your fork and the branch with your changes as the "compare" branch and the branch of our repository you
+      want to merge into as the "base" branch.
+    - Fill in the pull request form with a clear title and a detailed description of your changes.
+    - If your pull request is related to an issue or discussion thread, reference it in the description or/and under
+      the "Development" section.
+
+6. **Review and Adjust**:
+    - After submitting, at least one of our maintainers has to review your pull request. Be open to feedback also from
+      other contributors and ready to make adjustments as needed.
+    - If requested, make further commits to your branch to address feedback.
+
+7. **Acceptance and Merge**:
+    - Once your pull request is approved by a project maintainer and all CI checks pass, it will be merged.
+    - Congratulations! You've successfully contributed to the project.
+
+## Acknowledgment
+
+We thank the following contributors for their valuable contributions to the project:
+
+- 2024 Leon Budnick
+
+If you want to be listed as a contributor, add your information in the following format:
+
+```markdown
+- <year(s) of contribution(s)> <your name> <optionally your email>
+```
+
+If you have contributed in multiple years, you can define a range of years like `2020-2024` or single years
+like `2020-2022,2024`. Remember to update them with your first contribution in that year.
+
+**Thank you for contributing to our project!**