chore(docker): remove Dockerfile and related configurations

feat(app): update file type for download files in Gradio interface
feat(run_dev): modify command to run app with uv
feat(huggingface): add app_hf.py for Hugging Face Spaces deployment
docs(readme-hf): enhance documentation for Hugging Face integration

.github/workflows/deploy-to-huggingface.yml

@@ -17,21 +17,21 @@ jobs:
       - name: Push to Hugging Face Spaces
         env:
           HF_TOKEN: ${{ secrets.HF_TOKEN }}
-          HF_USERNAME: ${{ secrets.HF_USERNAME }}
-          SPACE_NAME: openEHR2FHIRquestionnaire
+          SPACE_NAME: cistec/openEHR2FHIRquestionnaire
         run: |
           git config --global user.email "github-actions[bot]@users.noreply.github.com"
           git config --global user.name "GitHub Actions"
 
-          # Install Hugging Face CLI
-          pip install huggingface_hub
+          # Install uv and Hugging Face CLI
+          pip install uv
+          uv pip install huggingface_hub
 
           # Login to Hugging Face
           huggingface-cli login --token $HF_TOKEN
 
           # Prepare the repository for pushing to HF Spaces
           # If this is the first deployment, create the space
-          python -c "from huggingface_hub import HfApi; api = HfApi(); api.create_repo(repo_id='$HF_USERNAME/$SPACE_NAME', repo_type='space', space_sdk='gradio')" || echo "Space already exists"
+          python -c "from huggingface_hub import HfApi; api = HfApi(); api.create_repo(repo_id='$SPACE_NAME', repo_type='space', space_sdk='gradio')" || echo "Space already exists"
 
           # Push to Hugging Face Spaces
-          git push https://oauth2:$HF_TOKEN@huggingface.co/spaces/$HF_USERNAME/$SPACE_NAME main:main -f
+          git push https://oauth2:$HF_TOKEN@huggingface.co/spaces/$SPACE_NAME main:main -f

.github/workflows/github-pages.yml

@@ -1,31 +0,0 @@
-name: Deploy to GitHub Pages
-
-on:
-  push:
-    branches:
-      - main
-  workflow_dispatch:
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v3
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
-        with:
-          path: './docs'
-
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2

.huggingface/README.md

@@ -1 +1,61 @@
-../README-HF.md
+---
+title: openEHR to FHIR Questionnaire Converter
+emoji: 📋
+colorFrom: blue
+colorTo: green
+sdk: gradio
+sdk_version: 3.35.2
+app_file: app_hf.py
+pinned: false
+license: mit
+---
+
+# openEHR to FHIR Questionnaire Converter
+
+Convert openEHR web templates to FHIR Questionnaire resources with support for multiple languages and FHIR versions.
+
+## Features
+
+* Convert openEHR web templates to FHIR Questionnaires
+* Support for multiple languages (en, de, fr, etc.)
+* Support for both FHIR R4 and R5 versions
+* Download converted FHIR Questionnaires as JSON files
+* Sample template available for testing
+
+## How to use
+
+1. Upload your openEHR web template (JSON file)
+2. Configure the conversion parameters:
+   - Languages (comma-separated)
+   - FHIR version (R4 or R5)
+   - Optional name and publisher attributes
+   - Text type handling
+3. Click "Convert to FHIR"
+4. View the resulting FHIR Questionnaire(s) and download them
+
+If you don't have a template to test with, click "Load Sample" to use a demonstration template.
+
+## Background
+
+The openEHR framework is a comprehensive approach to electronic health records that emphasizes interoperability and semantic precision. FHIR (Fast Healthcare Interoperability Resources) is a modern standard for healthcare data exchange.
+
+This tool bridges the gap between these standards by converting openEHR templates to FHIR Questionnaires, enabling organizations using openEHR to integrate with FHIR-based systems.
+
+## Source code
+
+The source code for this tool is available on GitHub: [cistec/openEHR2FHIRquestionnaire](https://github.com/cistec-com/openEHR2FHIRquestionnaire)
+
+## Citation
+
+```bibtex
+@software{OpenEHR2FHIRQuestionnaire,
+  author = {Cistec AG},
+  title = {openEHR to FHIR Questionnaire Mapper},
+  year = {2025},
+  url = {https://github.com/cistec-com/openEHR2FHIRquestionnaire}
+}
+```
+
+## License
+
+This project is licensed under the MIT License and developed by [Cistec AG](https://cistec.com).

Dockerfile

@@ -1,15 +0,0 @@
-FROM python:3.10-slim
-
-WORKDIR /app
-
-# Install uv
-RUN pip install --no-cache-dir uv
-
-COPY requirements.txt .
-RUN uv pip install --no-cache-dir -r requirements.txt
-
-COPY . .
-
-EXPOSE 7860
-
-CMD ["python", "app.py"]

README-HF.md

@@ -1,14 +1,14 @@
 # openEHR to FHIR Questionnaire Converter
 
-This tool allows you to convert openEHR web templates (JSON) to FHIR Questionnaire resources.
+This tool allows you to convert openEHR web templates (JSON) to FHIR Questionnaire resources. This application uses uv for efficient Python package management.
 
 ## Features
 
-- Convert openEHR web templates to FHIR Questionnaires
-- Support for multiple languages (en, de, fr, etc.)
-- Support for both FHIR R4 and R5 versions
-- Download converted FHIR Questionnaires as JSON files
-- Sample template available for testing
+* Convert openEHR web templates to FHIR Questionnaires
+* Support for multiple languages (en, de, fr, etc.)
+* Support for both FHIR R4 and R5 versions
+* Download converted FHIR Questionnaires as JSON files
+* Sample template available for testing
 
 ## How to use
 
@@ -31,7 +31,7 @@ This tool bridges the gap between these standards by converting openEHR template
 
 ## Source code
 
-The source code for this tool is available on GitHub: [cistec/openEHR2FHIRquestionnaire](https://github.com/cistec/openEHR2FHIRquestionnaire)
+The source code for this tool is available on GitHub: [cistec/openEHR2FHIRquestionnaire](https://github.com/cistec-com/openEHR2FHIRquestionnaire)
 
 ## License
 

README.md

@@ -5,23 +5,26 @@ You can generate multiple language variants, in case the respective translation
 
 ## Table of Contents
 
-- [Requirements](#requirements)
-- [Usage](#usage)
-  - [Command Line Interface](#command-line-interface)
-  - [Web Interface (Gradio)](#web-interface-gradio)
-  - [Docker Container](#docker-container)
-- [Local Development and Testing](#local-development-and-testing)
-- [Examples](#examples)
-- [Parameters](#parameters)
-- [License](#license)
-- [Contribution](#contribution)
-- [Citation](#citation)
+* [Requirements](#requirements)
+* [Usage](#usage)
+  + [Command Line Interface](#command-line-interface)
+  + [Web Interface (Gradio)](#web-interface-gradio)
+* [Examples](#examples)
+* [Parameters](#parameters)
+* [License](#license)
+* [Contribution](#contribution)
+* [Citation](#citation)
 
 ## Requirements
 
-- Python 3.7+
-- No special external libraries are required for the CLI version.
-- For the web interface: see `requirements.txt`
+### CLI Version (Core Script)
+
+* Python 3.7+ (the core conversion script has no external dependencies)
+
+### Web Interface (Gradio)
+
+* Python 3.8+ (required by Gradio)
+* Dependencies are managed through pyproject.toml
 
 ## Usage
 
@@ -39,101 +42,33 @@ python webtemplate_to_fhir_questionnaire_json.py \
     --text_types <from_annotations|...>
 ```
 
+Note: Since the CLI script has no external dependencies, it can be run directly with Python without requiring uv.
+
 ### Web Interface (Gradio)
 
 We've added a web interface using Gradio. To run it locally:
 
-1. Install the required dependencies using uv (recommended):
-
-   ```bash
-   # Install uv if you don't have it
-   pip install uv
-
-   # Install dependencies
-   uv pip install -r requirements.txt
-   ```
-
-   Alternatively, you can use pip:
-
-   ```bash
-   pip install -r requirements.txt
-   ```
+1. Install uv if you don't have it:
 
-2. Run the Gradio app:
+[UV Installation Guide](https://docs.astral.sh/uv/getting-started/installation/)
 
-   ```bash
-   python app.py
-   ```
-
-3. Open your browser at http://localhost:7860
-
-You can also try the hosted version of this tool on Hugging Face Spaces: [openEHR2FHIR Questionnaire Converter](https://huggingface.co/spaces/cistec/openEHR2FHIRquestionnaire)
-
-### Docker Container
-
-You can also run the web interface using Docker:
+2. Create a virtual environment and run the app:
 
 ```bash
-# Build the Docker image
-docker build -t openehr2fhir .
-
-# Run the container
-docker run -p 7860:7860 openehr2fhir
+uv venv --python 3.10
+source .venv/bin/activate
+uv run app.py
 ```
 
-Then open your browser at http://localhost:7860
-
-## Local Development and Testing
-
-For local development and testing, follow these steps:
-
-1. Clone the repository:
-
-   ```bash
-   git clone https://github.com/cistec/openEHR2FHIRquestionnaire.git
-   cd openEHR2FHIRquestionnaire
-   ```
-
-2. Create and activate a virtual environment (optional but recommended):
-
-   ```bash
-   python -m venv .venv
-   # On Windows
-   .venv\Scripts\activate
-   # On macOS/Linux
-   source .venv/bin/activate
-   ```
-
-3. Install dependencies using uv:
-
-   ```bash
-   pip install uv
-   uv pip install -r requirements.txt
-   ```
-
-4. Run the Gradio app with debug mode enabled:
-
-   ```bash
-   python app.py
-   ```
-
-   The app will automatically reload when you make changes to the code.
-
-5. Test the command-line interface:
-
-   ```bash
-   python webtemplate_to_fhir_questionnaire_json.py --input samples/sample_webtemplate.json
-   ```
+3. Open your browser at http://localhost:7860
 
-6. To test with your own web templates, place them in any directory and use the full path:
-   ```bash
-   python webtemplate_to_fhir_questionnaire_json.py --input /path/to/your/webtemplate.json
-   ```
+You can also try the hosted version of this tool on Hugging Face Spaces: [openEHR2FHIR Questionnaire Converter](https://huggingface.co/spaces/cistec/openEHR2FHIRquestionnaire)
 
 ### Examples
 
 ```bash
-python ./webtemplate_to_fhir_questionnaire_json.py \
+# Full example with all parameters
+python webtemplate_to_fhir_questionnaire_json.py \
     --input path_to_folder/web_template.json \
     --output questionnaire \
     --output_folder output_folder_path \
@@ -145,7 +80,13 @@ python ./webtemplate_to_fhir_questionnaire_json.py \
 ```
 
 ```bash
-python ./webtemplate_to_fhir_questionnaire_json.py --input web_template.json
+# Simple example with just input file
+python webtemplate_to_fhir_questionnaire_json.py --input web_template.json
+```
+
+```bash
+# Test with sample web template included in the repository
+python webtemplate_to_fhir_questionnaire_json.py --input samples/sample_webtemplate.json
 ```
 
 ### Parameters
@@ -155,11 +96,11 @@ python ./webtemplate_to_fhir_questionnaire_json.py --input web_template.json
 | --input         | Path to the Web Template JSON file to be converted into a FHIR Questionnaire. | Yes       | None                               |                                                                                                                                                           |
 | --output        | Base output file name for the generated FHIR Questionnaire.                   | No        | Input file base name.              | A timestamp (%Y%m%d\_%H%M) is prepended and the language code appended to the base name.                                                                  |
 | --output_folder | Path to the Web Template JSON file to be converted into a FHIR Questionnaire. | No        | `.` (current folder)               |                                                                                                                                                           |
-| --languages     | Comma-separated list of language codes (e.g., `en,de`)..                      | No        | `en`                               | A separate questionnaire is generated for each language.                                                                                                  |
-| --fhir_version  | FHIR version to use (either `R4` or `R5`).                                    | No        | `R4`                               |                                                                                                                                                           |
+| --languages     | Comma-separated list of language codes (e.g., `en,de` )..                      | No        | `en` | A separate questionnaire is generated for each language.                                                                                                  |
+| --fhir_version  | FHIR version to use (either `R4` or `R5` ).                                    | No        | `R4` |                                                                                                                                                           |
 | --name          | The `name` attribute for the FHIR Questionnaire.                              | No        | Web Template name (without spaces) |                                                                                                                                                           |
-| --publisher     | The `publisher` attribute for the FHIR Questionnaire.                         | No        | `converter`                        |                                                                                                                                                           |
-| --text_types    | Distinction of `DV_TEXT` mapping to `text` and `string` FHIR types.           | No        | None                               | `from_annotations`: Annotated items in the Web Template with `key=text_type` and `value=<string \| text>` are converted to the respective FHIR item type. |
+| --publisher     | The `publisher` attribute for the FHIR Questionnaire.                         | No        | `converter` |                                                                                                                                                           |
+| --text_types    | Distinction of `DV_TEXT` mapping to `text` and `string` FHIR types.           | No        | None                               | `from_annotations` : Annotated items in the Web Template with `key=text_type` and `value=<string \| text>` are converted to the respective FHIR item type. |
 
 ## License
 

app.py

@@ -107,7 +107,7 @@ def create_gradio_interface():
 
             with gr.Column():
                 output = gr.Markdown(label="Conversion Result")
-                download_files = gr.File(label="Download FHIR Questionnaires", file_count="multiple", type="file")
+                download_files = gr.File(label="Download FHIR Questionnaires", file_count="multiple", type="filepath")
 
         convert_btn.click(
             fn=convert_openehr_to_fhir,

app_hf.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# This is a special version of app.py for Hugging Face Spaces deployment
+# It simplifies the launch configuration to work properly on Hugging Face
+
+import os
+from app import create_gradio_interface, ensure_sample_dir
+
+if __name__ == "__main__":
+    # Create sample directory and file when app starts
+    ensure_sample_dir()
+
+    # Create and launch the Gradio interface
+    demo = create_gradio_interface()
+
+    # Launch with Hugging Face Spaces compatible settings
+    demo.launch(
+        server_name="0.0.0.0",  # Listen on all network interfaces
+        share=False,
+        server_port=7860  # Default port used by Hugging Face Spaces
+    )

docs/index.html

@@ -1,51 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <meta
-      http-equiv="refresh"
-      content="0; url=https://huggingface.co/spaces/cistec/openEHR2FHIRquestionnaire"
-    />
-    <title>openEHR to FHIR Questionnaire Converter</title>
-    <style>
-      body {
-        font-family: Arial, sans-serif;
-        text-align: center;
-        padding: 50px;
-        max-width: 800px;
-        margin: 0 auto;
-      }
-      h1 {
-        color: #2c3e50;
-      }
-      p {
-        font-size: 18px;
-        line-height: 1.5;
-        margin-bottom: 20px;
-      }
-      a {
-        display: inline-block;
-        background-color: #3498db;
-        color: white;
-        padding: 10px 20px;
-        text-decoration: none;
-        border-radius: 5px;
-        font-weight: bold;
-        margin-top: 20px;
-      }
-      a:hover {
-        background-color: #2980b9;
-      }
-    </style>
-  </head>
-  <body>
-    <h1>openEHR to FHIR Questionnaire Converter</h1>
-    <p>Redirecting to the Hugging Face Spaces app...</p>
-    <p>If you are not redirected automatically, click the button below:</p>
-    <a href="https://huggingface.co/spaces/cistec/openEHR2FHIRquestionnaire"
-      >Go to the App</a
-    >
-  </body>
-</html>

pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "openEHR2FHIRquestionnaire"
+version = "0.1.0"
+description = "Converts openEHR web templates to FHIR Questionnaire resources"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Cistec AG"}
+]
+dependencies = [
+    "gradio>=3.35.2",
+    "python-dateutil>=2.8.2"
+]
+
+[project.urls]
+Homepage = "https://github.com/cistec-com/openEHR2FHIRquestionnaire"
+"Bug Tracker" = "https://github.com/cistec-com/openEHR2FHIRquestionnaire/issues"
+
+[tool.uv]
+# UV-specific configuration can be added here if needed

run_dev.py

@@ -14,9 +14,9 @@ if __name__ == "__main__":
     # Ensure the current directory is in the Python path
     sys.path.insert(0, os.path.dirname(os.path.abspath(__file__)))
 
-    # Run the app with debug mode enabled
+    # Run the app with debug mode enabled using uv
     subprocess.run([
-        sys.executable,
+        "uv", "run",
         "app.py",
         "--debug",
         "--port", "7860"

samples/sample_webtemplate.json

@@ -0,0 +1,63 @@
+{
+  "templateId": "sample_template",
+  "tree": {
+    "id": "sample_root",
+    "name": "Sample Web Template",
+    "localizedNames": {
+      "en": "Sample Web Template",
+      "de": "Beispiel Web-Vorlage"
+    },
+    "localizedDescriptions": {
+      "en": "This is a sample web template for demonstration purposes",
+      "de": "Dies ist eine Beispiel-Web-Vorlage zu Demonstrationszwecken"
+    },
+    "nodeId": "sample_node_id",
+    "children": [
+      {
+        "id": "sample_section",
+        "name": "Sample Section",
+        "localizedNames": {
+          "en": "Sample Section",
+          "de": "Beispielabschnitt"
+        },
+        "rmType": "SECTION",
+        "nodeId": "sample_section_id",
+        "aqlPath": "/content[openEHR-EHR-SECTION.sample_section.v1]",
+        "children": [
+          {
+            "id": "sample_element",
+            "name": "Sample Element",
+            "localizedNames": {
+              "en": "Sample Element",
+              "de": "Beispielelement"
+            },
+            "rmType": "DV_CODED_TEXT",
+            "nodeId": "sample_element_id",
+            "aqlPath": "/content[openEHR-EHR-SECTION.sample_section.v1]/items[openEHR-EHR-ELEMENT.sample_element.v1]/value",
+            "inputs": [
+              {
+                "type": "CODED_TEXT",
+                "list": [
+                  {
+                    "value": "option1",
+                    "label": {
+                      "en": "Option 1",
+                      "de": "Option 1"
+                    }
+                  },
+                  {
+                    "value": "option2",
+                    "label": {
+                      "en": "Option 2",
+                      "de": "Option 2"
+                    }
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+}