Merge pull request #47 from CivicDataLab/dev

AImodel flow and Dataspace-sdk

Author: Deepthi-Chand

.github/workflows/publish-sdk.yml

@@ -0,0 +1,85 @@
+name: Publish SDK to PyPI
+permissions:
+  contents: write
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version number (e.g., 0.1.0, 0.2.0)'
+        required: true
+        type: string
+      release_notes:
+        description: 'Release notes'
+        required: false
+        type: string
+        default: 'Bug fixes and improvements'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+          pip install -e ".[dev]"
+
+      - name: Update version in setup.py
+        run: |
+          sed -i "s/version=\".*\"/version=\"${{ inputs.version }}\"/" setup.py
+
+      - name: Update version in pyproject.toml
+        run: |
+          sed -i "s/version = \".*\"/version = \"${{ inputs.version }}\"/" pyproject.toml
+
+      - name: Run tests
+        run: |
+          # Run mypy
+          mypy dataspace_sdk/ --ignore-missing-imports --config-file=/dev/null
+          # Run pytest
+          pytest tests/test_auth.py tests/test_base.py tests/test_client.py tests/test_datasets.py tests/test_aimodels.py tests/test_usecases.py tests/test_exceptions.py -v -p no:django -o addopts= --override-ini=django_find_project=false --noconftest --cov=dataspace_sdk --cov-report=term-missing
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Check package
+        run: |
+          twine check dist/*
+
+      - name: Publish to PyPI
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload dist/*
+
+      - name: Commit version changes
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add setup.py pyproject.toml
+          git commit -m "Bump version to ${{ inputs.version }}" || echo "No changes to commit"
+          git push || echo "No changes to push"
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v${{ inputs.version }}
+          release_name: SDK v${{ inputs.version }}
+          body: ${{ inputs.release_notes }}
+          draft: false
+          prerelease: false

.github/workflows/sdk-tests.yml

@@ -0,0 +1,43 @@
+name: SDK Tests
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Run type checking with mypy
+        run: |
+          mypy dataspace_sdk/ --ignore-missing-imports --config-file=/dev/null
+
+      - name: Run tests with pytest
+        run: |
+          pytest tests/test_auth.py tests/test_base.py tests/test_client.py tests/test_datasets.py tests/test_aimodels.py tests/test_usecases.py tests/test_exceptions.py -v -p no:django -o addopts= --override-ini=django_find_project=false --noconftest --cov=dataspace_sdk --cov-report=term-missing --cov-report=xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.gitignore

@@ -147,9 +147,11 @@ cython_debug/
 # IDE
 .vscode/
 .idea/
+.windsurf/
 
-#Resources upload folder
-resources/
+#Resources upload folder (but not SDK resources)
+/resources/
+!/dataspace_sdk/resources/
 
 #local env file
 .env
@@ -159,3 +161,10 @@ authorization/migrations/*
 
 # AWS files
 aws/.env.*
+
+#Public files
+files/public/*
+
+#dvc files
+dvc
+dvc/*

.sdkignore

@@ -0,0 +1,50 @@
+# SDK-specific ignore file for distribution
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+venv/
+ENV/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Django-specific (not needed for SDK)
+*.log
+db.sqlite3
+staticfiles/
+media/

CONTRIBUTING.md

@@ -53,35 +53,41 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
 ### Local Development
 
 1. Clone the repository:
+
    ```bash
    git clone https://github.com/CivicDataLab/DataSpaceBackend.git
    cd DataSpaceBackend
    ```
 
 2. Create a virtual environment:
+
    ```bash
    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
    ```
 
 3. Install dependencies:
+
    ```bash
    pip install -r requirements.txt
    ```
 
 4. Set up environment variables:
+
    ```bash
    cp .env.example .env
    # Edit .env with your configuration
    ```
 
 5. Run migrations:
+
    ```bash
    python manage.py migrate
    python manage.py init_roles
    ```
 
 6. Start the development server:
+
    ```bash
    python manage.py runserver
    ```
@@ -110,6 +116,7 @@ We use several tools to maintain code quality:
 - **mypy**: Type checking
 
 Run these before committing:
+
 ```bash
 black .
 isort .

DataSpace/settings.py

@@ -273,6 +273,7 @@
 ELASTICSEARCH_INDEX_NAMES = {
     "search.documents.dataset_document": "dataset",
     "search.documents.usecase_document": "usecase",
+    "search.documents.aimodel_document": "aimodel",
 }
 
 

MANIFEST.in

@@ -0,0 +1,6 @@
+include docs/sdk/README.md
+include docs/sdk/QUICKSTART.md
+include docs/sdk/DEVELOPMENT.md
+include LICENSE
+recursive-include dataspace_sdk *.py
+recursive-include examples *.py