Merge pull request #1 from clinicedc/feature/odm-study-definition-export

Add ODM 1.3.2 Study Definition export (scheduled CRFs)

Author: erikvw

.github/dependabot.yml

@@ -0,0 +1,8 @@
+---
+version: 2
+updates:
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -0,0 +1,81 @@
+---
+name: build
+
+# yamllint disable-line rule:truthy
+on: [push, pull_request]
+
+jobs:
+  build:
+    name: >-
+      build (Python ${{ matrix.python-version }},
+      Django ${{ matrix.django-version }},
+      ${{ matrix.database }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.12', '3.13', '3.14']
+        django-version: ['5.2', '6.0', 'dev']
+        database: ['mysql', 'postgres']
+
+    services:
+      mysql:
+        image: mysql:latest
+        env:
+          MYSQL_DATABASE: mysql
+          # pragma: allowlist secret
+          MYSQL_ROOT_PASSWORD: root
+        ports:
+          - 3306:3306
+        options: >-
+          --health-cmd="mysqladmin ping"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
+      postgres:
+        image: postgres:latest
+        env:
+          POSTGRES_DB: test_db
+          # pragma: allowlist secret
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - name: Install pycups and words dependency
+        run: |
+          sudo sed -i 's/azure\.//' /etc/apt/sources.list
+          sudo apt-get -y update
+          sudo apt-get install libcups2-dev wamerican
+
+      - uses: actions/checkout@v4
+
+      - name: Install uv and set the python version
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install dependencies
+        run: |
+          uv sync --dev --no-sources
+          if [ "${{ matrix.django-version }}" = "dev" ]; then
+            uv pip install \
+              "django @ git+https://github.com/django/django.git@main"
+          else
+            uv pip install \
+              "django~=${{ matrix.django-version }}.0"
+          fi
+
+      - name: Run tests
+        env:
+          SELECTED_DATABASE: ${{ matrix.database }}
+        run: |
+          uv run --dev --no-sources runtests.py

.yamllint

@@ -0,0 +1,13 @@
+# allow "on" until yamllint stops checking keys for truthy!
+# https://github.com/adrienverge/yamllint/issues/158
+---
+extends: default
+
+rules:
+  comments-indentation: disable
+  braces: disable
+  line-length:
+    max: 120
+  truthy:
+    level: error
+    allowed-values: ['true', 'false', 'on']

pyproject.toml

@@ -3,14 +3,16 @@ name = "edc-cdisc"
 version = "0.1.1"
 description = "CDISC compliance"
 readme = "README.rst"
-requires-python = ">=3.14"
+requires-python = ">=3.12"
 dependencies = [
     "clinicedc>=4.0.6",
+    "lxml>=5.0",
 ]
 
 [dependency-groups]
 dev = [
     "clinicedc-tests>=1.2.2",
+    "psycopg>=3.2",
     "ruff>=0.15.15",
     "sphinx>=9.1.0",
 ]

runtests.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+from clinicedc_tests.config import func_main
+
+if __name__ == "__main__":
+    func_main(
+        "edc_cdisc.tests.test_settings",
+        "edc_cdisc.tests",
+    )

src/edc_cdisc/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig as DjangoAppConfig
+
+
+class AppConfig(DjangoAppConfig):
+    name = "edc_cdisc"
+    verbose_name = "Edc CDISC"
+    default_auto_field = "django.db.models.BigAutoField"

src/edc_cdisc/odm/__init__.py

@@ -0,0 +1,3 @@
+from .serializer import ODMStudySerializer
+
+__all__ = ["ODMStudySerializer"]