first commit

Author: roy-coder

.github/workflows/docker-ghcr.yml

@@ -0,0 +1,35 @@
+name: Build and Push to GHCR
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: read
+  packages: write
+  actions: read
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ghcr.io/${{ github.repository }}:latest
+

Dockerfile

@@ -0,0 +1,23 @@
+FROM python:3.12-slim
+
+WORKDIR /app
+
+# Install system dependencies that might be required by MarkItDown
+RUN apt-get update && apt-get install -y \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy requirements first for better caching
+COPY requirements.txt .
+
+# Install Python dependencies
+RUN pip install --no-cache-dir -r requirements.txt
+
+# Copy application code
+COPY app.py .
+
+# Expose the port the app runs on
+EXPOSE 5000
+
+# Run the application
+CMD ["gunicorn", "--bind", "0.0.0.0:5000", "app:app"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bitovi
+
+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.

README.md

@@ -0,0 +1,80 @@
+# MarkItDown HTTP API Wrapper
+
+This is a simple HTTP API wrapper for the MarkItDown package that allows you to convert various document formats to text using a RESTful API.
+
+## Files Included
+
+- `app.py`: The Flask application that provides the HTTP API
+- `requirements.txt`: Python dependencies
+- `Dockerfile`: Instructions for building the Docker image
+
+## Getting Started
+
+### Running with docker-compose.yml
+
+```yaml
+version: "3.8"
+
+services:
+  markitdown_api:
+    image: ghcr.io/bitovi/markitdown_api:latest
+    container_name: markitdown_api
+    ports:
+      - "5000:5000"
+```
+
+```sh
+docker compose up --build -d
+```
+
+The service will be available at <http://localhost:5000>
+
+### API Endpoints
+
+#### Health Check
+
+```http
+GET /health
+```
+
+Returns a 200 OK response if the service is running correctly.
+
+#### Convert a File
+
+```http
+POST /convert
+```
+
+Parameters:
+
+- `file`: The file to convert (multipart/form-data)
+
+Example usage with curl:
+
+```bash
+curl -X POST -F "[email protected]" -H "Content-Type: multipart/form-data" -H "Accept: application/json" http://localhost:5000/convert
+```
+
+Example response:
+
+```json
+{
+  "markdown": "Extracted text from the document..."
+}
+```
+
+## Development
+
+To modify the application:
+
+1. Edit the `app.py` file as needed
+2. Rebuild and restart the Docker container:
+
+```bash
+docker compose down
+docker compose up --build -d
+```
+
+## Extending the API
+
+You can extend the API by adding more endpoints to `app.py` or by adding more features to the existing endpoint.

app.py

@@ -0,0 +1,59 @@
+from flask import Flask, request, jsonify
+import os
+import tempfile
+from markitdown import MarkItDown
+from werkzeug.utils import secure_filename
+
+app = Flask(__name__)
+
+@app.route('/health', methods=['GET'])
+def health_check():
+    return jsonify({"status": "healthy"}), 200
+
+@app.route('/convert', methods=['POST'])
+def convert_file():
+    # Check if file is present in the request
+    if 'file' not in request.files:
+        return jsonify({"error": "No file provided"}), 400
+    
+    file = request.files['file']
+    
+    # Check if the file has a name
+    if file.filename == '':
+        return jsonify({"error": "No file selected"}), 400
+    
+    # Create a temporary file to save the uploaded file
+    temp_dir = tempfile.mkdtemp()
+    file_path = os.path.join(temp_dir, secure_filename(file.filename))
+    
+    try:
+        # Save the file temporarily
+        file.save(file_path)
+        
+        # Process with MarkItDown
+        md = MarkItDown()
+        result = md.convert(file_path)
+        
+        # Prepare the response
+        response = {
+            "markdown": result.text_content
+        }
+        
+        # Add any other relevant data from the result object if needed
+        # Example: if result has metadata, add it to the response
+        if hasattr(result, 'metadata'):
+            response["metadata"] = result.metadata
+        
+        return jsonify(response), 200
+    
+    except Exception as e:
+        return jsonify({"error": str(e)}), 500
+    
+    finally:
+        # Clean up the temporary file
+        if os.path.exists(file_path):
+            os.remove(file_path)
+        
+        # Clean up the temporary directory
+        if os.path.exists(temp_dir):
+            os.rmdir(temp_dir)

requirements.txt

@@ -0,0 +1,3 @@
+flask>=2.3.3
+markitdown
+gunicorn>=20.1.0