omotes-simulator-core 0.0.5.dev0__tar.gz → 0.0.8__tar.gz

omotes-simulator-core-0.0.8/.github/workflows/ci.yml

@@ -0,0 +1,110 @@
+name: Build-Test-Lint-etc (linux)
+
+on: [push]
+
+jobs:
+
+  flake8-lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v3
+      - name: Set up Python environment
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11
+      - name: flake8 Lint
+        uses: TrueBrain/actions-flake8@v2
+        with:
+          plugins: Flake8-pyproject==1.2.3 flake8-docstrings==1.7.0 flake8-quotes==3.3.2
+          # only_warn: 1  #causes action to always be succesful, but still provide annotations
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+#        python-version: [3.8, 3.9, 3.10, 3.11]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+    - run: |
+        ./ci/linux/create_venv.sh
+        ./ci/linux/install_dev.sh
+
+    - name: run unit tests
+      run: |
+        ./ci/linux/test_unit.sh
+
+    - name: Surface failing tests
+      if: always()
+      uses: pmeier/pytest-results-action@main
+      with:
+        # A list of JUnit XML files, directories containing the former, and wildcard
+        # patterns to process.
+        # See @actions/glob for supported patterns.
+        path: test-results.xml
+
+        # Add a summary of the results at the top of the report
+        # Default: true
+        summary: true
+
+        # Select which results should be included in the report.
+        # Follows the same syntax as
+        # `pytest -r`
+        # Default: fEX
+        display-options: fEX
+
+        # Fail the workflow if no JUnit XML was found.
+        # Default: true
+        fail-on-empty: true
+
+  typecheck:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+#        python-version: [3.8, 3.9, 3.10, 3.11]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+    - run: |
+        ./ci/linux/create_venv.sh
+        ./ci/linux/install_dev.sh
+
+    - name: Add mypy annotator
+      uses: pr-annotators/mypy-pr-annotator@v1.0.0
+
+    - name: run typechecker
+      run: |
+        ./ci/linux/typecheck.sh
+
+  build:
+    name: Build the python package
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.11" ]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - run: |
+          ./ci/linux/create_venv.sh
+          ./ci/linux/install_dev.sh
+
+      - name: build
+        run: |
+          ./ci/linux/build_python_package.sh

omotes-simulator-core-0.0.8/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '22 6 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

omotes-simulator-core-0.0.8/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: PyPi release
+run-name: Releasing next version 🚀
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.11" ]
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: 'pip'
+      - run: |
+          ./ci/linux/create_venv.sh
+          ./ci/linux/update_dependencies.sh
+          ./ci/linux/install_dependencies.sh
+
+      - name: build
+        run: |
+          ./ci/linux/build_python_package.sh
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

omotes-simulator-core-0.0.8/.gitignore

@@ -0,0 +1,230 @@
+# 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/
+pip-wheel-metadata/
+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/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+doc/*/_build/
+doc/*/_static/
+doc/*/_templates/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__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/
+
+### PyCharm+all ###
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### PyCharm+all Patch ###
+# Ignore everything but code style settings and run configurations
+# that are supposed to be shared within teams.
+
+.idea/*
+
+!.idea/codeStyles
+!.idea/runConfigurations
+
+unit_test_coverage/
+test-results.xml
+.env.*
+
+# requirements.txt files are ignored
+# otherwise, the release-workflow may fail due to 
+# changes in these files
+# requirements.txt files are updated as part of the build
+requirements.txt
+dev-requirements.txt

omotes-simulator-core-0.0.8/.taplo.toml

@@ -0,0 +1,5 @@
+include = ["pyproject.toml"]
+
+
+[schema]
+path = "https://json.schemastore.org/pyproject.json"

omotes-simulator-core-0.0.8/.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Module",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "simulator_core"
+        }
+    ]
+}

omotes-simulator-core-0.0.8/.vscode/settings.json

@@ -0,0 +1,20 @@
+{
+  "python.analysis.typeCheckingMode": "basic",
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter"
+  },
+  "mypy.runUsingActiveInterpreter": true,
+  "python.testing.unittestArgs": [
+    "-v",
+    "-s",
+    "./unit_test",
+    "-p",
+    "test*.py",
+    "--cov=simulator_core",
+    "--cov-report html",
+    "--cov-report term-missing",
+    "--cov-fail-under 80"
+  ],
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": true,
+}

omotes-simulator-core-0.0.8/CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+All notable changes to this project 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).
+
+## [Unreleased] - 2024-3-31
+### Added
+- New functionality added to the project, with reference to issue-ticket (#123)
+- Another new item (#1234)
+
+### Fixed
+- bugfixes, with references to your issue-tickets (#123)
+- another bugfix (#1234)
+
+### Changed
+- Changes,  for example code structure
+- but also changed/updated dependencies
+- Add references to tickets where applicable (#123)
+
+### Removed
+- Files that have been removed
+- Functionality that has been removed
+- Add references to tickets where applicable (#123)
+
+## [0.0.1] - 2023-09-21
+### Added
+- Kickoff of Nieuwe Warmte Nu!.
+- initialized repo from template.
+
+### Changed
+- everything.

omotes-simulator-core-0.0.8/CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# This file
+This file should describe the development process for this project and include instruction on 
+how to run/build your project.  Any environment settings/requirements?
+
+# Development guidelines
+The general proces is as follows:
+* Create a branch on your local working copy
+* make code modifications, including tests, documentation, etc
+* commit/push changes to remote/origin
+* submit a pull request for merging into master
+* Discuss with code reviewer if/what changes are needed
+* when all discussions are resolved, the PR will be merged by the reviewer
+* Update Changelog!
+
+
+# Code Quality guide lines
+Quality guide lines serve to improve quality. They should not be busy work nor work against developers.
+They should be of value.
+
+## Code review
+- Every commit should be created on its own branch and submitted per pull request to be merged with the main branch.
+- Every pull request must be reviewed by at least one other developer and all comments must be resolved.
+- No linting issues may remain before merging.
+- No type checking issues may remain before merging.
+- Code reviews are not about distrust. They are about sharing knowledge about the code base, sharing knowledge about
+  writing code and increasing quality by collaboration.
+
+## Documentation
+- Every function must have documentation explaining what the function does in a summary and explaining
+  each argument and return type.
+
+## Linting
+- Linting maintains a shared quality of the code base across repositories.
+- Rules of the linter may only be ignored when approved by the software leads. Prefer to silence individual lines by <TODO show how to silence individual errors>'
+
+## Type checking
+- Every function must have a return type and an argument list annotated with functions.
+- Rules of the type checker may only be ignored when approved by the software leads.
+- 
+
+## Testing
+### Unit testing
+- Every function should be covered by a unit test. Some functions allow more easily for unit tests and some are not
+  worth unit testing. This is up to the teams discretion.
+- A unit test should test some significant amount of code. If the test function is similar or equal to the logic being tested,
+the amount of code being tested is too small. If the test function tests whole modules or multiple layers of code, the amount
+of code being tested is too big. The amount of code being tested is referred to as the 'unit-under-test'.
+- Use mocks to isolate 'unit-under-test' where applicable.
+- Coverage percentage should be >80%. This is a guideline, not a hard rule. Breaking this guideline is allowed if the 
+  arguments has swayed the developersteam and not just the developer and reviewer.
+

{omotes-simulator-core-0.0.5.dev0/src/omotes_simulator_core.egg-info → omotes-simulator-core-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omotes-simulator-core
-Version: 0.0.5.dev0
+Version: 0.0.8
 Summary: Core library of the NWN simulator
 Author-email: Michiel Tukker <michiel.tukker@deltares.nl>
 Project-URL: homepage, https://www.nwn.nu

omotes-simulator-core-0.0.8/VERSION

@@ -0,0 +1 @@
+0.0.1

omotes-simulator-core-0.0.8/ci/linux/build_python_package.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+git reset --hard # Reset any changes made during the create_env
+python -m build

omotes-simulator-core-0.0.8/ci/linux/create_venv.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+python3.11 -m venv ./.venv
+. .venv/bin/activate
+pip3 install pip-tools
+./ci/linux/update_dependencies.sh
+./ci/linux/install_dependencies.sh

omotes-simulator-core-0.0.8/ci/linux/install_dependencies.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+pip-sync

omotes-simulator-core-0.0.8/ci/linux/install_dev.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+pip-sync  ./requirements.txt ./dev-requirements.txt

omotes-simulator-core-0.0.8/ci/linux/lint.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+flake8 ./src/simulator_core

omotes-simulator-core-0.0.8/ci/linux/test_unit.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+PYTHONPATH='$PYTHONPATH:src/' pytest --junit-xml=test-results.xml unit_test/

omotes-simulator-core-0.0.8/ci/linux/typecheck.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+python -m mypy ./src/simulator_core

omotes-simulator-core-0.0.8/ci/linux/update_dependencies.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env sh
+
+. .venv/bin/activate
+pip-compile --output-file=requirements.txt pyproject.toml
+pip-compile --extra=dev --output-file=dev-requirements.txt -c requirements.txt pyproject.toml

omotes-simulator-core-0.0.8/ci/win32/create_venv.cmd

@@ -0,0 +1,12 @@
+rem Short script to initialize virtual environment using venv and pip
+rem @echo off
+
+pushd .
+cd /D "%~dp0"
+py -3.11 -m venv ..\..\venv
+call ..\..\venv\Scripts\activate.bat
+python -m pip install pip-tools setuptools wheel
+REM call .\update_dependencies.cmd
+call .\install_dependencies.cmd
+call .\install_dev.cmd
+popd

omotes-simulator-core-0.0.8/ci/win32/install_dependencies.cmd

@@ -0,0 +1,6 @@
+
+pushd .
+cd /D "%~dp0"
+cd ..\..\
+pip-sync
+popd

omotes-simulator-core-0.0.8/ci/win32/install_dev.cmd

@@ -0,0 +1,6 @@
+
+pushd .
+cd /D "%~dp0"
+cd ..\..\
+pip-sync .\requirements.txt .\dev-requirements.txt
+popd

omotes-simulator-core-0.0.8/ci/win32/lint.cmd

@@ -0,0 +1,8 @@
+rem Short script to run linting
+rem @echo off
+
+pushd .
+cd /D "%~dp0"
+cd ..\..\
+flake8 .\src\simulator_core
+popd

omotes-simulator-core-0.0.8/ci/win32/test_unit.cmd

@@ -0,0 +1,9 @@
+
+pushd .
+cd /D "%~dp0"
+
+cd ..\..\
+call .\venv\Scripts\activate
+set PYTHONPATH=.\src\;%$PYTHONPATH%
+pytest unit_test/
+popd