dataspace-sdk 0.1.0__tar.gz

dataspace_sdk-0.1.0/.dockerignore

@@ -0,0 +1,2 @@
+venv
+db.sqlite3

dataspace_sdk-0.1.0/.env.example

@@ -0,0 +1,14 @@
+DB_ENGINE=django.db.backends.postgresql
+DB_NAME=postgres
+DB_USER=postgresuser
+DB_PASSWORD=postgrespassword
+DB_HOST=backend_db
+DB_PORT=5432
+TELEMETRY_URL=http://otel-collector:4317
+ELASTICSEARCH_INDEX=http://elasticsearch:9200
+ELASTICSEARCH_USERNAME=elasticuser
+ELASTICSEARCH_PASS=elasticpass
+URL_WHITELIST=http://localhost:8000,http://localhost,http://localhost:3000
+DEBUG=True
+SECRET_KEY=your-secret-key
+REDIS_URL=redis://redis:6379/1

dataspace_sdk-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,74 @@
+name: Bug Report
+description: File a bug report to help us improve
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: contact
+    attributes:
+      label: Contact Details
+      description: How can we get in touch with you if we need more info?
+      placeholder: ex. email@example.com
+    validations:
+      required: false
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Please provide detailed steps to reproduce the issue
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: dropdown
+    id: version
+    attributes:
+      label: Version
+      description: What version of our software are you running?
+      options:
+        - main (latest)
+        - dev
+        - Other (please specify in description)
+    validations:
+      required: true
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What environment are you using?
+      multiple: true
+      options:
+        - Development
+        - Production
+        - Docker
+        - Local setup
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/CivicDataLab/DataSpaceBackend/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

dataspace_sdk-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/CivicDataLab/DataSpaceBackend/discussions
+    about: Ask questions and discuss ideas with the community
+  - name: Security Issues
+    url: mailto:tech@civicdatalab.in
+    about: Please report security vulnerabilities via email

dataspace_sdk-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,61 @@
+name: Feature Request
+description: Suggest an idea for this project
+title: "[Feature]: "
+labels: ["enhancement", "triage"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for suggesting a new feature!
+  - type: textarea
+    id: problem
+    attributes:
+      label: Is your feature request related to a problem?
+      description: A clear and concise description of what the problem is.
+      placeholder: I'm always frustrated when [...]
+    validations:
+      required: false
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: dropdown
+    id: component
+    attributes:
+      label: Which component does this relate to?
+      multiple: true
+      options:
+        - API
+        - GraphQL
+        - Authentication
+        - Database
+        - Search
+        - Documentation
+        - Testing
+        - Other
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/CivicDataLab/DataSpaceBackend/blob/main/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

dataspace_sdk-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,64 @@
+# Pull Request
+
+## Description
+
+Brief description of the changes introduced by this PR.
+
+## Type of Change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update
+- [ ] Performance improvement
+- [ ] Code refactoring
+- [ ] Test improvements
+
+## Related Issues
+
+Fixes #(issue number)
+Closes #(issue number)
+Relates to #(issue number)
+
+## Changes Made
+
+- [ ] Change 1
+- [ ] Change 2
+- [ ] Change 3
+
+## Testing
+
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] I have tested this change manually
+
+### Test Instructions
+
+Please describe how reviewers can test your changes:
+
+1. Step 1
+2. Step 2
+3. Step 3
+
+## Screenshots (if applicable)
+
+Add screenshots to help explain your changes.
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have run `black .`, `isort .`, and `flake8` and fixed any issues
+- [ ] Database migrations are included (if applicable)
+
+## Additional Notes
+
+Add any additional notes or context about the PR here.

dataspace_sdk-0.1.0/.github/workflows/deploy-to-ecs.yml

@@ -0,0 +1,147 @@
+name: Deploy to Amazon ECS
+
+on:
+  push:
+    branches:
+      - dev
+  workflow_dispatch:
+
+env:
+  AWS_REGION: ${{ secrets.AWS_REGION }}
+  ECR_REPOSITORY: ${{ secrets.ECR_REPOSITORY }}
+  ECS_CLUSTER: ${{ secrets.ECS_CLUSTER }}
+  ECS_EXECUTION_ROLE_ARN: ${{ secrets.ECS_EXECUTION_ROLE_ARN }}
+  APP_NAME: dataspace
+  APP_PORT: 8000
+  DB_ENGINE: django.db.backends.postgresql
+  DB_PORT: 5432
+  DEBUG_MODE: "False"
+  TELEMETRY_URL: http://otel-collector:4317
+  CPU_UNITS: 256
+  MEMORY_UNITS: 512
+  SSM_PATH_PREFIX: /dataspace
+  ENVIRONMENT: ${{ secrets.ENVIRONMENT || 'dev' }}
+
+jobs:
+  deploy-infrastructure:
+    name: Deploy Infrastructure
+    runs-on: ubuntu-latest
+    environment: development
+    if: github.event_name == 'workflow_dispatch' || contains(github.event.head_commit.modified, 'aws/cloudformation')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Deploy CloudFormation stack
+        run: |
+          aws cloudformation deploy \
+            --template-file aws/cloudformation/dataspace-infrastructure.yml \
+            --stack-name dataspace-${{ env.ENVIRONMENT }}-infrastructure \
+            --parameter-overrides \
+              Environment=${{ env.ENVIRONMENT }} \
+              VpcId=${{ secrets.VPC_ID }} \
+              SubnetIds=${{ secrets.SUBNET_IDS }} \
+              DBUsername=${{ secrets.DB_USERNAME }} \
+              DBPassword=${{ secrets.DB_PASSWORD }} \
+              DBName=${{ secrets.DB_NAME }} \
+              ElasticsearchPassword=${{ secrets.ELASTICSEARCH_PASSWORD }} \
+              DjangoSecretKey=${{ secrets.DJANGO_SECRET_KEY }} \
+            --capabilities CAPABILITY_IAM \
+            --no-fail-on-empty-changeset
+
+  deploy-app:
+    name: Deploy Application
+    runs-on: ubuntu-latest
+    environment: development
+    needs: deploy-infrastructure
+    if: always() # Run even if infrastructure deployment is skipped
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v1
+
+      - name: Build, tag, and push image to Amazon ECR
+        id: build-image
+        env:
+          ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+          IMAGE_TAG: ${{ github.sha }}
+        run: |
+          docker build -t $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG .
+          docker push $ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG
+          echo "image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG" >> $GITHUB_OUTPUT
+
+      - name: Download task definition and get EFS ID
+        run: |
+          aws ecs describe-task-definition --task-definition dataspace --query taskDefinition > aws/current-task-definition.json
+          aws ecs describe-task-definition --task-definition dataspace-otel-collector --query taskDefinition > aws/current-otel-task-definition.json
+          # Get the EFS ID from CloudFormation export
+          EFS_ID=$(aws cloudformation list-exports --query "Exports[?Name=='dataspace-${{ env.ENVIRONMENT }}-MigrationsFileSystemId'].Value" --output text)
+          echo "EFS_ID=$EFS_ID" >> $GITHUB_ENV
+
+      - name: Update container image only
+        id: task-def-app
+        uses: aws-actions/amazon-ecs-render-task-definition@v1
+        with:
+          task-definition: aws/current-task-definition.json
+          container-name: dataspace
+          image: ${{ steps.build-image.outputs.image }}
+
+      - name: Deploy main application ECS task definition
+        uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+        with:
+          task-definition: ${{ steps.task-def-app.outputs.task-definition }}
+          service: ${{ secrets.ECS_SERVICE }}
+          cluster: ${{ env.ECS_CLUSTER }}
+          wait-for-service-stability: true
+
+  deploy-otel:
+    name: Deploy OpenTelemetry Collector
+    runs-on: ubuntu-latest
+    environment: development
+    needs: deploy-app
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Download current OpenTelemetry task definition
+        id: download-otel-taskdef
+        run: |
+          aws ecs describe-task-definition \
+            --task-definition dataspace-otel-collector \
+            --query taskDefinition > aws/current-otel-task-definition.json
+          cat aws/current-otel-task-definition.json
+
+      - name: Deploy OpenTelemetry ECS task definition
+        uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+        with:
+          task-definition: aws/current-otel-task-definition.json
+          service: ${{ secrets.ECS_OTEL_SERVICE }}
+          cluster: ${{ env.ECS_CLUSTER }}
+          wait-for-service-stability: true

dataspace_sdk-0.1.0/.gitignore

@@ -0,0 +1,162 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+#db file
+sqlite3.db
+db.sqlite3
+
+# C extensions
+*.so
+
+#config
+config.ini
+
+# 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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.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/
+
+# IDE
+.vscode/
+.idea/
+.windsurf/
+
+#Resources upload folder
+resources/
+
+#local env file
+.env
+api/migrations/*
+authorization/migrations/*
+
+
+# AWS files
+aws/.env.*

dataspace_sdk-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,75 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+        exclude: ^aws/cloudformation/.*\.yml$
+    -   id: check-added-large-files
+    -   id: debug-statements
+
+-   repo: https://github.com/psf/black
+    rev: 24.2.0
+    hooks:
+    -   id: black
+        language_version: python3.11
+
+-   repo: https://github.com/pycqa/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+        args: ["--profile", "black"]
+
+-   repo: local
+    hooks:
+    -   id: cloudformation-validate
+        name: AWS CloudFormation Validation
+        description: Validates CloudFormation templates using AWS CLI
+        entry: bash -c 'aws cloudformation validate-template --template-body file://$0 || exit 1'
+        language: system
+        files: ^aws/cloudformation/.*\.yml$
+        require_serial: true
+        pass_filenames: true
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+    -   id: mypy
+        language: python
+        language_version: python3.11
+        additional_dependencies:
+          - types-requests
+          - types-PyYAML
+          - types-python-dateutil
+          - types-setuptools
+          - django-stubs
+          - djangorestframework-stubs
+          - pandas-stubs
+          - pandas
+          - deepdiff
+          - types-redis
+          - strawberry-graphql
+          - strawberry-graphql-django
+          - django-environ
+          - structlog
+          - django
+          - elasticsearch-dsl
+          - django-elasticsearch-dsl
+          - django-elasticsearch-dsl-drf
+          - pyecharts
+          - selenium
+          - python-decouple
+          - djangorestframework
+          - django-debug-toolbar
+          - django-ratelimit
+          - django-cors-headers
+          - psycopg2-binary
+          - python-dotenv
+          - uvicorn
+          - djangorestframework-simplejwt
+          - python-keycloak
+          - django-activity-stream
+
+        args: [--config-file=mypy.ini]
+        exclude: ^tests/