tiled 0.1.0__tar.gz

tiled-0.1.0/.codecov.yml

@@ -0,0 +1,10 @@
+# show coverage in CI status, not as a comment.
+comment: off
+coverage:
+  status:
+    project:
+      default:
+        target: auto
+    patch:
+      default:
+        target: auto

tiled-0.1.0/.coveragerc

@@ -0,0 +1,14 @@
+[run]
+source =
+    tiled
+[report]
+omit =
+    */python?.?/*
+    */site-packages/nose/*
+    # ignore _version.py and versioneer.py
+    .*version.*
+    *_version.py
+    */_tests/*
+
+exclude_lines =
+    if __name__ == '__main__':

tiled-0.1.0/.devcontainer/devcontainer.json

@@ -0,0 +1,31 @@
+{
+	"name": "tiled-devcontainer",
+	"build": {
+		"context": "..",
+		"dockerfile": "../Containerfile",
+		"target": "developer",
+		"args": {
+			"PYTHON_VERSION": "3.9"
+		}
+	},
+	"containerEnv": {
+		"TILED_BUILD_SKIP_UI": "1"
+	},
+	"features": {
+		"ghcr.io/devcontainers/features/git:1": {}
+	},
+	"postCreateCommand": "set -ex && uv sync --extra all --extra dev --project src && uv tool install pre-commit --with pre-commit-uv && SHELL=bash uv tool update-shell && pre-commit install",
+	"customizations": {
+		"vscode": {
+			"settings": {
+				"python.defaultInterpreterPath": "/app/bin/python"
+			},
+			"extensions": [
+				"ms-python.python",
+				"ms-toolsai.jupyter",
+				"GitHub.codespaces",
+				"ms-vscode-remote.remote-containers"
+			]
+		}
+	}
+}

tiled-0.1.0/.flake8

@@ -0,0 +1,13 @@
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    build,
+    dist,
+    versioneer.py,
+    tiled/_version.py,
+    tiled/serialization/_zipfile_py39.py,
+    docs/source/conf.py,
+    share,
+    web-frontend,
+max-line-length = 115

tiled-0.1.0/.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

tiled-0.1.0/.gitattributes

@@ -0,0 +1,3 @@
+.git_archival.txt export-subst
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

tiled-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,3 @@
+### Checklist
+- [ ] Add a Changelog entry
+- [ ] Add the ticket number which this PR closes to the comment section

tiled-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,161 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+    - main
+  schedule:
+      - cron: '00 4 * * *'  # daily at 4AM
+
+env:
+  TEST_TAG: bluesky/tiled:test
+
+jobs:
+  pre-commit:
+    name: Static Code Checks
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: pre-commit/action@v3.0.0
+
+  linux_checks:
+
+    name: Test on Linux
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+      fail-fast: false
+    steps:
+
+    - uses: actions/checkout@v3
+
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tiled
+      run: uv sync --all-extras
+
+    # TODO Find a new image to use.
+    # https://github.com/bluesky/tiled/issues/1109
+    # - name: Start LDAP service in container.
+    #   shell: bash -l {0}
+    #   run: source continuous_integration/scripts/start_LDAP.sh
+
+    - name: Download SQLite example data.
+      shell: bash -l {0}
+      run: source continuous_integration/scripts/download_sqlite_data.sh
+
+    - name: Start PostgreSQL service in container.
+      shell: bash -l {0}
+      run: source continuous_integration/scripts/start_postgres.sh
+
+    - name: Start Redis service in container.
+      shell: bash -l {0}
+      run: source continuous_integration/scripts/start_redis.sh
+
+
+    - name: Ensure example data is migrated to current catalog database schema.
+      # The example data is expected to be kept up to date to the latest Tiled
+      # release, but this CI run may include some unreleased schema changes,
+      # so we run a migration here.
+      shell: bash -l {0}
+      run: |
+        set -vxeuo pipefail
+        uv run tiled catalog upgrade-database sqlite:///tiled_test_db_sqlite.db
+        uv run tiled catalog upgrade-database postgresql://postgres:secret@localhost:5432/tiled-example-data
+
+    - name: Test with pytest
+      shell: bash -l {0}
+      run: |
+        set -vxeuo pipefail
+        uv run coverage run -m pytest -v
+        uv run coverage report -m
+        uv run coverage xml -o cov.xml
+      env:
+        # Provide test suite with PostgreSQL and Redis databases to use.
+        TILED_TEST_POSTGRESQL_URI: postgresql://postgres:secret@localhost:5432
+        TILED_TEST_REIDS_URI: redis://localhost:6379
+        # TODO Reinstate after finding a new image to use
+        # https://github.com/bluesky/tiled/issues/1109
+        # # Opt in to LDAPAuthenticator tests.
+        # TILED_TEST_LDAP: 1
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        name: ${{ inputs.python-version }}/${{ inputs.runs-on }}
+        files: cov.xml
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  windows_checks:
+    name: Test on Windows
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+      fail-fast: false
+    steps:
+
+    - uses: actions/checkout@v3
+
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tiled
+      run: uv sync --all-extras
+      env:
+        TILED_BUILD_SKIP_UI: 1
+
+    - name: Test with pytest
+      run: uv run pytest -v
+
+  container_canary:
+    name: Build and validate container
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Install Container Canary
+      run: |
+        curl -L https://github.com/NVIDIA/container-canary/releases/download/v0.2.1/canary_linux_amd64 > /usr/local/bin/canary
+        chmod +x /usr/local/bin/canary
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435  # v3
+
+    - name: Build Docker image on multiple arch
+      uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83  # v6
+      with:
+        context: .
+        file: Containerfile
+        platforms: linux/amd64,linux/arm64
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Tag and load Docker image on single arch for testing (will use cache)
+      uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83  # v6
+      with:
+        context: .
+        file: Containerfile
+        load: true
+        push: false
+        tags: ${{ env.TEST_TAG }}
+        cache-from: type=gha
+        cache-to: type=gha,mode=max
+
+    - name: Validate container
+      run: |
+        canary validate --file canary-validator.yml ${{ env.TEST_TAG }}

tiled-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Documentation
+
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+      fail-fast: false
+
+    steps:
+
+    - uses: actions/checkout@v3
+
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tiled
+      run: uv sync --all-extras
+
+    - name: Build Docs
+      shell: bash -l {0}
+      run: uv run make -C docs/ html

tiled-0.1.0/.github/workflows/publish-docs.yml

@@ -0,0 +1,52 @@
+name: Publish Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    if: github.repository_owner == 'bluesky'
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12"]
+      fail-fast: false
+
+    steps:
+
+    - name: Set env.REPOSITORY_NAME  # just the repo, as opposed to org/repo
+      shell: bash -l {0}
+      run: |
+        export REPOSITORY_NAME=${GITHUB_REPOSITORY#*/}
+        echo "REPOSITORY_NAME=${REPOSITORY_NAME}" >> $GITHUB_ENV
+
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 1000  # should be enough to reach the most recent tag
+
+    - name: Install uv and set the python version
+      uses: astral-sh/setup-uv@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install tiled
+      run: uv sync --all-extras
+
+    - name: Build Docs
+      shell: bash -l {0}
+      run: uv run make -C docs/ html
+
+    - name: Deploy documentation to blueskyproject.io.
+      # We pin to the SHA, not the tag, for security reasons.
+      # https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
+      uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501  # v3.7.3
+      with:
+        deploy_key: ${{ secrets.ACTIONS_DOCUMENTATION_DEPLOY_KEY }}
+        publish_branch: master
+        publish_dir: ./docs/build/html
+        external_repository: bluesky/bluesky.github.io
+        destination_dir: ${{ env.REPOSITORY_NAME }}  # just the repo name, without the "bluesky/"
+        keep_files: true  # Keep old files.
+        force_orphan: false  # Keep git history.

tiled-0.1.0/.github/workflows/publish-image.yml

@@ -0,0 +1,83 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Create and publish image and chart
+
+on:
+  push:
+    branches: ['main']
+    tags: ['v*']
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@74a5d142397b4f367a81961eba4e8cd7edddf772  # v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f  # v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=raw,value=latest
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83  # v6
+        if: github.ref_type == 'tag'
+        with:
+          context: .
+          file: Containerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      - name: Install Helm
+        uses: Azure/setup-helm@v4
+        id: install
+        if: github.ref_type == 'tag'
+
+      - name: Lint Helm chart
+        run: helm lint helm/tiled
+
+      - name: Log in to the Chart registry
+        run: |
+          echo ${{ secrets.GITHUB_TOKEN }} | helm registry login ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} --username ${{ github.repository_owner }} --password-stdin
+
+      - name: Package and Push chart
+        if: github.ref_type == 'tag'
+        run: |
+          helm dependencies update helm/tiled
+          helm package helm/tiled --version ${{ steps.meta.outputs.version }} --app-version ${{ steps.meta.outputs.version }} -d /tmp/
+
+      - name: Publish Helm chart
+        if: github.ref_type == 'tag'
+        run: |
+          helm push /tmp/tiled-${{ steps.meta.outputs.version }}.tgz oci://ghcr.io/bluesky/charts

tiled-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,45 @@
+name: Publish package on PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  dist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+        with:
+          fetch-depth: 0
+
+      - name: Build SDist and wheel
+        run: pipx run build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          path: dist/*
+
+      - name: Check metadata
+        run: pipx run twine check dist/*
+
+  publish:
+    needs: [dist]
+    environment: pypi
+    permissions:
+      id-token: write
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

tiled-0.1.0/.gitignore

@@ -0,0 +1,87 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+
+# Sphinx documentation
+docs/build/
+docs/source/reference/generated/
+
+# Builds
+/build
+/dist
+/tiled.egg-info
+/web-frontend/dist
+
+/web-frontend/node_modules
+
+# pytest
+.pytest_cache/
+
+# Unit test / coverage reports
+coverage/
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+cover/*
+
+# PyBuilder
+target/
+
+# Editor files
+#mac
+.DS_Store
+*~
+
+#vim
+*.swp
+*.swo
+
+#pycharm
+.idea/
+
+#VSCode
+.vscode/*
+!.vscode/launch.json
+
+#Ipython Notebook
+.ipynb_checkpoints
+
+example_files/
+tokens.json
+
+# generated docs
+docs/source/reference/client-profiles.md
+docs/source/reference/service-configuration.md
+docs/source/reference/api.yml
+
+# placed React bundle
+share/tiled/ui
+
+config.yaml
+config.yml
+*.sqlite
+*.db
+*.db-wal
+*.db-shm
+
+prometheus_data
+grafana_data
+data
+alembic.ini
+
+tiled/_version.py
+
+.env
+.asv/
+venv/
+# pixi environments
+.pixi
+pixi.lock
+# uv environments
+uv.lock
+.venv
+# pixi environments
+.pixi/*
+!.pixi/config.toml

tiled-0.1.0/.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

tiled-0.1.0/.mypy.ini

@@ -0,0 +1,35 @@
+[mypy]
+ignore_errors = True
+ignore_missing_imports = True
+disallow_untyped_defs = False
+disallow_untyped_calls = False
+check_untyped_defs = False
+disallow_incomplete_defs = False
+
+
+[mypy-tiled.adapters.*]
+ignore_errors = False
+ignore_missing_imports = False
+check_untyped_defs = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_calls = True
+disallow_untyped_decorators = True
+
+[mypy-tiled._tests.adapters.*]
+ignore_errors = False
+ignore_missing_imports = False
+check_untyped_defs = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_calls = True
+disallow_untyped_decorators = False
+
+[mypy-tiled._tests.test_protocols]
+ignore_errors = False
+ignore_missing_imports = False
+check_untyped_defs = True
+disallow_untyped_defs = True
+disallow_incomplete_defs = True
+disallow_untyped_calls = True
+disallow_untyped_decorators = True

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

@@ -0,0 +1,37 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+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-ast
+    -   id: check-case-conflict
+    -   id: check-merge-conflict
+    -   id: check-symlinks
+    -   id: check-yaml
+        # These yaml files output valid yaml only after templating
+        exclude: ^helm/tiled/templates/
+    -   id: debug-statements
+
+-   repo: https://github.com/pycqa/flake8
+    rev: 6.1.0
+    hooks:
+    -   id: flake8
+
+-   repo: https://github.com/timothycrosley/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+
+-   repo: https://github.com/psf/black
+    rev: 23.10.1
+    hooks:
+    -   id: black
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.9.0
+    hooks:
+    -    id: mypy
+         args: [--strict]

tiled-0.1.0/.vscode/launch.json

@@ -0,0 +1,28 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Debug Tiled Server",
+        "type": "python",
+        "request": "launch",
+        "module": "tiled",
+        "args": [
+          "serve",
+          "config",
+          "--host", "127.0.0.1",
+          "--port", "8000",
+          "--scalable"
+        ],
+        "env": {
+          // Point this at any of your YAML configs or a config directory
+          "TILED_CONFIG":
+"${workspaceFolder}/example_configs/single_catalog_single_user.yml",
+          "TILED_SINGLE_USER_API_KEY": "secret",
+        },
+        "console": "integratedTerminal",
+        "justMyCode": false,
+        "jinja": true,
+        "subProcess": true
+      }
+    ]
+  }