overity 0.0.1__tar.gz

overity-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+# Inspired by https://blog.pecar.me/automate-hatch-publish
+
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    environment: release
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+
+      - name: Build package
+        run: hatch build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

overity-0.0.1/.gitignore

@@ -0,0 +1,162 @@
+# 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/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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/

overity-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+  - repo: local
+    hooks:
+      - id: lint
+        language: system
+        name: "Run linter"
+        entry: hatch run lint:code-rules
+
+      - id: format
+        language: system
+        name: "Run black formatter"
+        entry: hatch run lint:code-format
+
+      - id: check-headers
+        language: system
+        name: "Check source headers"
+        entry: hatch run lint:code-headers

overity-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,109 @@
+Contributing
+============
+
+Suggest a new feature
+---------------------
+
+If you like to see a new feature, feel free to open an issue. We shall look if it can be planned on an upcoming version if it matches the scheduled roadmap.
+
+Submitting code changes
+-----------------------
+
+Submitting code changes follow the usual procedure:
+
+1. Fork the repo
+2. Make your changes
+3. Make sure your changes follow the required code rules and format, more info below
+4. Submit a PR
+
+Please make sure to attach your PR with an existing issue, or create a new one.
+
+
+Development
+-----------
+
+### Tools
+
+The project uses the following tools:
+
+- `hatch`: project management, virtual environment, packaging tools;
+- `pre-commit`: quality assurance for repo focusing on developer experience (DX).
+
+You can install these tools (one time only) using pip:
+
+```
+pip install hatch pre-commit
+```
+
+The first time you checkout the repository, make sure to configure `pre-commit` properly:
+
+```
+pre-commit install
+```
+
+### Environments
+
+This project makes an extensive use of hatch's "environments" fulfilling various needs:
+
+#### `docs` environment
+
+This environment allow to build the project's documentation using `mkdocs`. To build the project documentation, simply run:
+
+```
+hatch run docs:build
+```
+
+Generated documentation shall be available in the `site` output folder.
+
+
+#### `types` environment
+
+This auxiliary environment uses `mypy` for type checking.
+
+You can run the type checker using:
+
+```
+hatch run types:check
+```
+
+#### `lint` environment
+
+This environment contains the `ruff` linter as well as the `black` formatter. These shall be already run by `pre-commit` when comitting to the repository.
+
+Behind the scenes, the `pre-commit` hooks makes use of the following commands:
+
+- Lint the code using `ruff`: `hatch run lint:code-rules`
+- Format the code using `black`: `hatch run lint:code-format`
+
+
+### File header
+
+Please use the following header format for source files:
+
+```
+[Main file title]
+=================
+
+**[Month] [year]**
+
+- [Your Name] ([your email])
+
+> This file is part of the Overity.ai project, and is licensed under
+> the terms of the Apache 2.0 license. See the LICENSE file for more
+> information.
+
+Optional file description and documentation
+```
+
+Here is an example:
+
+```
+This file is here for this
+==========================
+
+**August 2025**
+
+- John Doe (john.doe@mail.com)
+```
+
+You can omit your mail if you do not want to share it.

overity-0.0.1/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.4
+Name: overity
+Version: 0.0.1
+Project-URL: Documentation, https://overity.ai
+Project-URL: Issues, https://github.com/fdmysterious/overity/issues
+Project-URL: Source, https://github.com/fdmysterious/overity
+Author-email: Florian Dupeyron <florian.dupeyron@elsys-design.com>
+License-Expression: Apache-2.0
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.8
+Requires-Dist: jinja2==3.1.6
+Requires-Dist: jsonschema==4.23.0
+Requires-Dist: nbformat==5.10.4
+Requires-Dist: parsimonious==0.10.0
+Requires-Dist: toml==0.10.2
+Description-Content-Type: text/markdown
+
+<p align="center">
+    <img src="./docs/assets/img/overity-banner.png"  alt="Overity.ai" />
+</p>
+
+Overity.ai - MLOps oriented framework for trustworthy Edge-AI
+=============================================================
+
+[![PyPI - Version](https://img.shields.io/pypi/v/overity.svg)](https://pypi.org/project/overity)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/overity.svg)](https://pypi.org/project/overity)
+
+> **🚧 Overity.ai is currently under heavy development. Initial release is planned for end of 2025. Leave a star to stay informed! 🚧**
+
+Overity.ai is a open-source MLOps oriented framework for optimization,
+qualification, and deployment of Edge-AI models in critical systems, focusing
+on traceability and trustworthy AI.
+
+It helps you organize training, optimization and validation methods, track
+and version your datasets and models with complete traceability graphs, as well
+as leveraging Hardware-In-The-Loop (HIL) testing to validate embedded use-cases.
+
+Whether it's for local development or complex deployments in complete MLOps environments,
+Overity.ai provides all the necessary tools to create the next ground-breaking Edge-AI
+Revoluuuuuuuution! :smile:
+
+
+Getting started
+---------------
+
+To get started, please refer to the [Getting started](#) guide.
+
+
+Contributing
+------------
+
+If you want to contribute, please refer to the [contributing](CONTRIBUTING.md) guidelines.
+
+
+License
+-------
+
+This project is licensed under the terms of the terms of the Apache 2.0 license. Please refer to the
+[LICENSE](./LICENSE) file for more information.
+
+
+Main authors
+------------
+
+- Florian Dupeyron (florian.dupeyron@elsys-design.com) : Project leader and creator
+
+
+Contact Us
+----------
+
+Please send an email at community@elsys-design.com

overity-0.0.1/README.md

@@ -0,0 +1,54 @@
+<p align="center">
+    <img src="./docs/assets/img/overity-banner.png"  alt="Overity.ai" />
+</p>
+
+Overity.ai - MLOps oriented framework for trustworthy Edge-AI
+=============================================================
+
+[![PyPI - Version](https://img.shields.io/pypi/v/overity.svg)](https://pypi.org/project/overity)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/overity.svg)](https://pypi.org/project/overity)
+
+> **🚧 Overity.ai is currently under heavy development. Initial release is planned for end of 2025. Leave a star to stay informed! 🚧**
+
+Overity.ai is a open-source MLOps oriented framework for optimization,
+qualification, and deployment of Edge-AI models in critical systems, focusing
+on traceability and trustworthy AI.
+
+It helps you organize training, optimization and validation methods, track
+and version your datasets and models with complete traceability graphs, as well
+as leveraging Hardware-In-The-Loop (HIL) testing to validate embedded use-cases.
+
+Whether it's for local development or complex deployments in complete MLOps environments,
+Overity.ai provides all the necessary tools to create the next ground-breaking Edge-AI
+Revoluuuuuuuution! :smile:
+
+
+Getting started
+---------------
+
+To get started, please refer to the [Getting started](#) guide.
+
+
+Contributing
+------------
+
+If you want to contribute, please refer to the [contributing](CONTRIBUTING.md) guidelines.
+
+
+License
+-------
+
+This project is licensed under the terms of the terms of the Apache 2.0 license. Please refer to the
+[LICENSE](./LICENSE) file for more information.
+
+
+Main authors
+------------
+
+- Florian Dupeyron (florian.dupeyron@elsys-design.com) : Project leader and creator
+
+
+Contact Us
+----------
+
+Please send an email at community@elsys-design.com

overity-0.0.1/devbox.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://raw.githubusercontent.com/jetify-com/devbox/0.16.0/.schema/devbox.schema.json",
+  "packages": [
+    "hatch@latest",
+    "pre-commit@latest"
+  ],
+  "shell": {
+    "init_hook": [
+      "echo 'Welcome to devbox!' > /dev/null"
+    ],
+    "scripts": {
+      "test": [
+        "echo \"Error: no test specified\" && exit 1"
+      ]
+    }
+  }
+}

overity-0.0.1/devbox.lock

@@ -0,0 +1,137 @@
+{
+  "lockfile_version": "1",
+  "packages": {
+    "github:NixOS/nixpkgs/nixpkgs-unstable": {
+      "last_modified": "2025-09-04T15:48:01Z",
+      "resolved": "github:NixOS/nixpkgs/0987f8f26d7b889e23a7c533ae6d998b27924899?lastModified=1757000881&narHash=sha256-Cl3ep4eX9Katb2m%2FDJLmbfltPSRaWnVAFtoI%2BVPVDLk%3D"
+    },
+    "hatch@latest": {
+      "last_modified": "2025-07-28T17:09:23Z",
+      "resolved": "github:NixOS/nixpkgs/648f70160c03151bc2121d179291337ad6bc564b#hatch",
+      "source": "devbox-search",
+      "version": "1.14.1",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/hyrsm4gy2lny5mr2ybrykf0d66inwavi-hatch-1.14.1",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/blghwr6czadb6y58r3nhis8zsvj6ksv0-hatch-1.14.1-dist"
+            }
+          ],
+          "store_path": "/nix/store/hyrsm4gy2lny5mr2ybrykf0d66inwavi-hatch-1.14.1"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/ijbwkxw72glzd94a81aan7r37yd0qxhk-hatch-1.14.1",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/hradafnl6w3gfpmqib0lkckfq5qfl8yj-hatch-1.14.1-dist"
+            }
+          ],
+          "store_path": "/nix/store/ijbwkxw72glzd94a81aan7r37yd0qxhk-hatch-1.14.1"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/993idmhc92cdv250bslhxdr3dwq0szm6-hatch-1.14.1",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/2x26fl5i7gm6f357b4lajy1zx5g94s18-hatch-1.14.1-dist"
+            }
+          ],
+          "store_path": "/nix/store/993idmhc92cdv250bslhxdr3dwq0szm6-hatch-1.14.1"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/dbw97q4vivr8zzyw473fllx1g94jq4zd-hatch-1.14.1",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/w3dhmw0acz2kl7fqn19m6m2yjxkk528a-hatch-1.14.1-dist"
+            }
+          ],
+          "store_path": "/nix/store/dbw97q4vivr8zzyw473fllx1g94jq4zd-hatch-1.14.1"
+        }
+      }
+    },
+    "pre-commit@latest": {
+      "last_modified": "2025-08-11T07:05:29Z",
+      "resolved": "github:NixOS/nixpkgs/9585e9192aadc13ec3e49f33f8333bd3cda524df#pre-commit",
+      "source": "devbox-search",
+      "version": "4.2.0",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/awyg4wwb7w117sr32zbw453yylzy1sv5-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/6j8b2k8vcm8ff3fwrwpkxr2q796yqwzl-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/awyg4wwb7w117sr32zbw453yylzy1sv5-pre-commit-4.2.0"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/z7aiyfndjqrzk0igjdzjf2sab137083p-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/mr9jivn3fc4g4ncb25ij73481ilmba4k-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/z7aiyfndjqrzk0igjdzjf2sab137083p-pre-commit-4.2.0"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/mx4vjrjzfxsarwkx12ddvn18kvphsds4-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/hgf3j4hj0ng2xwq71n5a8j02y6zha5gq-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/mx4vjrjzfxsarwkx12ddvn18kvphsds4-pre-commit-4.2.0"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/h9f0ac5z0scz7fp4p8xznw2m04xx45in-pre-commit-4.2.0",
+              "default": true
+            },
+            {
+              "name": "dist",
+              "path": "/nix/store/k9svwjpac38jf5c1zlxdhvhpk3ljf57r-pre-commit-4.2.0-dist"
+            }
+          ],
+          "store_path": "/nix/store/h9f0ac5z0scz7fp4p8xznw2m04xx45in-pre-commit-4.2.0"
+        }
+      }
+    }
+  }
+}

overity-0.0.1/docs/assets/img/overity-logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 -4 144.3 148.67" fill="none" stroke="white" stroke-width="6" stroke-linecap="round" stroke-linejoin="round"><g transform="translate(-681.57 -586.58)"><g stroke-linejoin="round"><path d="m681.57 628.61 64.297 102.61 22.014 0.0333-53.011-84.942 56.511 0.61181-10.534-18.656z"></path><path d="m714.89 646.31 22.343 0.25162 29.257 47.704 47.125-84.42 12.26 18.489-57.998 102.91z"></path><path d="m687.02 615.48-5.457 13.13 79.277-0.34273 6.7519-13.13z"></path></g><path d="m760.84 628.26 6.7519-13.13 11.018 21.047-7.2361 10.739z"></path><path d="m759.46 682.81 7.025 11.454 47.125-84.42-13.098-0.13228z"></path><circle cx="786.11" cy="598.01" r="11.433" stroke-linejoin="bevel" fill="currentColor"></circle></g></svg>

overity-0.0.1/docs/index.md

@@ -0,0 +1,3 @@
+# Hello world!
+
+This is a test package documentation.

overity-0.0.1/mkdocs.yml

@@ -0,0 +1,54 @@
+site_name: "Overity.ai"
+copyright: "2025, crafted with ♥ at <a href='https://www.advans-group.com'>Advans group</a>"
+
+theme:
+  name: material
+  logo: assets/img/overity-logo.svg
+  palette:
+    primary: black
+    scheme: slate
+
+
+use_directory_urls: false
+
+plugins:
+  - search
+  - roamlinks
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [src]
+          import:
+            - https://docs.python.org/3/objects.inv
+          options:
+            heading_level: 1
+            inherited_members: true
+            merge_init_into_class: true
+            parameter_headings: true
+            separate_signature: true
+            show_root_heading: true
+            show_root_full_path: false
+            show_signature_annotations: true
+            show_symbol_type_heading: true
+            siganture_crossrefs: true
+            summary: true
+
+  - gen-files:
+      scripts:
+        - scripts/gen_ref_nav.py
+
+  - literate-nav:
+       nav_file: SUMMARY.md
+
+markdown_extensions:
+  - admonition
+  - footnotes
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.arithmatex:
+      generic: true
+
+# TODO # Add mathjax stuff?