lx-dtypes 0.1.1__tar.gz

lx_dtypes-0.1.1/.coderabbitai.yaml

@@ -0,0 +1,3 @@
+reviews:
+  path_filters:
+    - "!**/migrations/**"

lx_dtypes-0.1.1/.envrc

@@ -0,0 +1,4 @@
+# Fetch hash
+#  direnv fetchurl "https://raw.githubusercontent.com/cachix/devenv/v1.11.2/devenv/direnvrc"
+source_url "https://raw.githubusercontent.com/cachix/devenv/v1.11.2/devenv/direnvrc" "sha256-ato6rQhHH/nvLMD8uCnJ8zTD8kxsm15WlfXkMNsICEQ="
+use_devenv

lx_dtypes-0.1.1/.github/codecov.yml

@@ -0,0 +1,18 @@
+coverage:
+  status:
+    project:
+      default:
+        informational: true
+        target: 90%
+        threshold: 10%
+    patch:
+      default:
+        informational: true
+
+comment:
+  layout: "diff, flags, files"
+  behavior: default
+  require_changes: true # if true: only post the comment if coverage changes
+  require_base: false # [true :: must have a base report to post]
+  require_head: true # [true :: must have a head report to post]
+  hide_project_coverage: false # [true :: only show coverage on the git diff aka patch coverage]

lx_dtypes-0.1.1/.github/dependabot.yml

@@ -0,0 +1,44 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "05:00"
+      timezone: "Europe/Berlin"
+    target-branch: "main"
+    open-pull-requests-limit: 1
+    labels:
+      - "dependencies"
+      - "automation"
+    groups:
+      runtime-deps:
+        dependency-type: "production"
+      docs-stack:
+        patterns:
+          - "sphinx*"
+          - "myst-parser"
+          - "furo"
+          - "linkify-it-py"
+      qa-tooling:
+        patterns:
+          - "pytest*"
+          - "mypy*"
+          - "ruff"
+          - "flake8"
+          - "twine"
+          - "pre-commit"
+          - "build"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "05:00"
+      timezone: "Europe/Berlin"
+    target-branch: "main"
+    open-pull-requests-limit: 1
+    labels:
+      - "dependencies"
+      - "automation"

lx_dtypes-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,58 @@
+name: Lint and Test
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+      - prototype
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+
+      - name: Ruff lint
+        run: ruff check lx_dtypes tests
+
+      - name: Ruff format check
+        run: ruff format --check lx_dtypes tests
+
+      - name: Type checking
+        run: mypy lx_dtypes
+
+      - name: Run tests
+        run: pytest -m "not localfiles" --junitxml=junit.xml -o junit_family=legacy --cov=lx_dtypes --cov-report=xml
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

lx_dtypes-0.1.1/.github/workflows/docs.yml

@@ -0,0 +1,43 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install documentation extras
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[docs]
+
+      - name: Build HTML docs
+        working-directory: docs
+        run: make html
+
+      - name: Link check
+        working-directory: docs
+        run: make linkcheck
+
+      - name: Upload HTML artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html
+          if-no-files-found: error

lx_dtypes-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,88 @@
+name: Publish
+
+on:
+  release:
+    types:
+      - published
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  build-artifacts:
+    name: Build sdist and wheel
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build toolchain
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build distribution
+        run: python -m build
+
+      - name: Check metadata
+        run: twine check dist/*
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist-artifacts
+          path: dist
+
+  publish-testpypi:
+    name: Upload to TestPyPI
+    needs: build-artifacts
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/')
+
+    environment:
+      name: testpypi
+
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist-artifacts
+          path: dist
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+        with:
+          packages-dir: dist
+          repository-url: https://test.pypi.org/legacy/
+          # Twine 5.x (bundled with the action) cannot parse Metadata-Version 2.4,
+          # so rely on the earlier `twine check` step instead.
+          verify-metadata: false
+
+  publish-pypi:
+    name: Upload to PyPI
+    needs: publish-testpypi
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+
+    environment:
+      name: pypi
+
+    steps:
+      - uses: actions/download-artifact@v5
+        with:
+          name: dist-artifacts
+          path: dist
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0
+        with:
+          packages-dir: dist
+          # Twine 5.x (bundled with the action) cannot parse Metadata-Version 2.4,
+          # so rely on the earlier `twine check` step instead.
+          verify-metadata: false

lx_dtypes-0.1.1/.gitignore

@@ -0,0 +1,223 @@
+# Development
+.devenv/
+.direnv/
+*log.yaml
+junit.xml
+data/smartie
+knowledge_base.yaml
+.devenv.flake.nix
+**/models/**/tests/**.yaml
+star_upper_gi_interface_export_test.yaml
+star_upper_gi_kb_export_test.yaml
+docs_build.tar.gz
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.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
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# 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
+# .envrc
+.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/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+test_interface_export.yaml
+
+standardized_dataset/**

lx_dtypes-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.7
+    hooks:
+      - id: ruff
+        args: ["--fix", "lx_dtypes", "tests"]
+        pass_filenames: false
+      - id: ruff-format
+        args: ["lx_dtypes", "tests"]
+        pass_filenames: false
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy type check
+        entry: mypy lx_dtypes
+        language: system
+        pass_filenames: false
+      - id: pytest
+        name: pytest suite
+        entry: pytest
+        language: system
+        pass_filenames: false

lx_dtypes-0.1.1/.python-version

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

lx_dtypes-0.1.1/CHANGELOG.md

@@ -0,0 +1,17 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Project metadata reshaped for eventual PyPI publication.
+- Development dependency group separated from runtime requirements.
+
+## [0.1.0] - 2025-12-10
+
+### Added
+- Initial public packaging baseline.

lx_dtypes-0.1.1/CONTRIBUTING.md

@@ -0,0 +1,116 @@
+# Contributing to lx-data-models
+
+Thanks for helping improve `lx-dtypes`! This guide describes how to work on the
+project, from setting up your environment to preparing releases.
+
+## Code of Conduct
+
+Participation is governed by the [MIT License](LICENSE) and the Lux Group
+community standards. Please be respectful and constructive in all interactions.
+
+## Getting Started
+
+1. **Fork & Clone**
+   ```bash
+   git clone https://github.com/<your-username>/lx-data-models.git
+   cd lx-data-models
+   git remote add upstream https://github.com/wg-lux/lx-data-models.git
+   ```
+2. **Create a Virtual Environment** (Python 3.12 only)
+   ```bash
+   python -m venv .venv
+   source .venv/bin/activate
+   ```
+3. **Install Dependencies**
+   ```bash
+   pip install -e ".[dev]"
+   ```
+4. **Keep Your Branch Updated**
+   ```bash
+   git fetch upstream
+   git rebase upstream/main
+   ```
+
+## Development Workflow
+
+- **Coding style**: Use `ruff format` (or `black`) and `ruff check`. Configure
+  IDEs to enforce 88-character lines.
+- **Static typing**: Run `mypy lx_dtypes` before submitting.
+- **Testing**: All changes must pass `pytest` with coverage ≥70% (configured via
+  `pyproject.toml`).
+- **Docs**: If you change APIs or behavior, update the Sphinx docs in `docs/`
+   and relevant docstrings. Always rebuild locally before opening a PR.
+- **Commits**: Keep commits focused. Use descriptive titles (optionally
+  Conventional Commits). Reference issues/PRs when applicable.
+
+## Pre-commit Hooks (optional but recommended)
+
+```bash
+pip install pre-commit
+pre-commit install
+pre-commit run --all-files
+```
+
+The provided configuration runs the same commands as CI, but with local
+auto-fix for lint/format issues: `ruff --fix lx_dtypes tests`, `ruff format
+lx_dtypes tests`, `mypy lx_dtypes`, and the full `pytest` suite. Because the
+hooks run against the whole repository (`pass_filenames: false`), a passing
+local run guarantees that CI will agree.
+
+## Documentation Workflow
+
+1. Install the documentation extras (already included in `.[dev]`):
+   ```bash
+   pip install -e ".[docs]"
+   ```
+2. Build the HTML site and verify links:
+   ```bash
+   make -C docs html
+   make -C docs linkcheck
+   ```
+3. Commit any updated Markdown/HTML assets under `docs/_build` **only** when
+   publishing to GitHub Pages; otherwise keep build artifacts out of the repo.
+
+## Submitting Changes
+
+1. Ensure lint, type-checks, and tests pass:
+   ```bash
+   ruff check lx_dtypes tests
+   mypy lx_dtypes
+   pytest
+   ```
+2. Update `CHANGELOG.md` under `Unreleased`.
+3. Push your branch and open a pull request against `wg-lux:main`.
+4. Fill out the PR template describing motivation, changes, and testing.
+5. Address review feedback promptly; stay responsive until merge.
+
+## Release Checklist
+
+1. Confirm `CHANGELOG.md` lists the new version and highlights key changes.
+2. Bump the version in `pyproject.toml` (and ensure `lx_dtypes.__version__`
+   reflects it).
+3. Tag the release (`git tag vX.Y.Z && git push origin vX.Y.Z`).
+4. Build artifacts and upload:
+   ```bash
+   rm -rf dist
+   python -m build
+   twine check dist/*
+   twine upload --repository testpypi dist/*
+   twine upload dist/*
+   ```
+5. Alternatively, trigger the `Publish` GitHub Action (release event or manual
+   dispatch) once Trusted Publishers are configured for TestPyPI/PyPI and the
+   `testpypi`/`pypi` environments are approved. The workflow builds packages,
+   uploads to TestPyPI, then PyPI for tagged releases—no API tokens required.
+6. Announce in the relevant channels and update documentation badges.
+
+## Specific Guides
+### Importer
+Based on the example in `lx_dtypes/importer/smartie`, you can create import modules for your own datasets. When requesting a pull request to add a new importer, please ensure that:
+- mock data or data samples are included for testing purposes under `tests/data/your_importer_name/`
+- appropriate tests are added under `tests/importer/test_your_importer_name.py`
+
+## Need Help?
+
+Open a discussion or issue on GitHub, or reach out to the maintainers listed in
+`pyproject.toml`. Happy modeling!

lx_dtypes-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 AG-Lux
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.