feat: Initial commit

Co-authored-by: Ernst Würger <[email protected]>
Co-authored-by: Ngan-Huyen Thi-Nguyen <[email protected]>
Co-authored-by: Viktor Kravchenko <[email protected]>

.git_archival.txt

@@ -0,0 +1,7 @@
+Copyright DB Netz AG and contributors
+SPDX-License-Identifier: CC0-1.0
+
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1,11 @@
+# Copyright DB Netz AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+* text=auto
+
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf
+
+*.{sh,py} text eol=lf
+
+.git_archival.txt  export-subst

.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+# Copyright DB Netz AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Docs
+
+on:
+  push:
+    branches: ["master"]
+
+jobs:
+  sphinx:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.11"
+      - name: Upgrade pip
+        run: |
+          python -m pip install -U pip
+      - name: Install dependencies
+        run: |
+          python -m pip install '.[docs]'
+      - name: Auto-generate APIDOC sources
+        run: |-
+          sphinx-apidoc --output-dir docs/source/code --force .
+      - name: Create docs
+        run: |
+          make -C docs html
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          force_orphan: true
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html

.github/workflows/lint.yml

@@ -0,0 +1,42 @@
+# Copyright DB Netz AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Lint
+
+on:
+  push:
+    branches: ["*"]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.11"
+      - name: Upgrade pip
+        run: |-
+          python -m pip install -U pip
+      - name: Install pre-commit
+        run: |-
+          python -m pip install pre-commit types-docutils
+      - name: Run Pre-Commit
+        run: |-
+          pre-commit run --all-files
+  pylint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.11"
+      - name: Upgrade pip
+        run: |-
+          python -m pip install -U pip
+      - name: Install pylint
+        run: |-
+          python -m pip install pylint
+      - name: Run pylint
+        run: |-
+          pylint -dfixme capella_diff_tools || exit $(($? & ~24))

.github/workflows/publish.yml

@@ -0,0 +1,40 @@
+# Copyright DB Netz AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+name: Publish package
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+    tags: ["v*"]
+  pull_request:
+
+jobs:
+  publish:
+    name: Publish artifacts
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          cache: pip
+          cache-dependency-path: pyproject.toml
+          python-version: "3.11"
+      - name: Install dependencies
+        run: python -m pip install -U pip build twine
+      - name: Build packages
+        run: python -m build
+      - name: Verify packages
+        run: python -m twine check dist/*
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: Artifacts
+          path: 'dist/*'
+      - name: Publish to PyPI
+        if: startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/master'
+        run: python -m twine upload -u __token__ -p ${{ secrets.PYPI_TOKEN }} --non-interactive dist/*

.gitignore

@@ -0,0 +1,158 @@
+# Copyright DB Netz AG and contributors
+# SPDX-License-Identifier: CC0-1.0
+
+# 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/
+docs/source/code/
+docs/source/_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/