Release 0.1.0

.env.docker

@@ -1,9 +1,54 @@
 # Init Postgres database
-POSTGRES_DB=arrakis
-POSTGRES_USER=arrakis
+POSTGRES_DB=data_rentgen
+POSTGRES_USER=data_rentgen
 POSTGRES_PASSWORD=changeme
+POSTGRES_INITDB_ARGS=--encoding=UTF-8 --lc-collate=C --lc-ctype=C
 
-# See Backend -> Configuration documentation
-ARRAKIS__DATABASE__URL=postgresql+asyncpg://arrakis:changeme@db:5432/arrakis
-ARRAKIS__SERVER__LOGGING__PRESET=colored
-ARRAKIS__SERVER__DEBUG=false
+# Init Kafka
+KAFKA_CFG_NODE_ID=0
+KAFKA_CFG_PROCESS_ROLES=controller,broker
+KAFKA_CFG_LISTENERS=DOCKER://:9092,LOCALHOST://:9093,CONTROLLER://:9094,INTERBROKER://:9095
+KAFKA_CFG_ADVERTISED_LISTENERS=DOCKER://kafka:9092,LOCALHOST://localhost:9093,INTERBROKER://broker:9095
+KAFKA_CFG_LISTENER_SECURITY_PROTOCOL_MAP=CONTROLLER:PLAINTEXT,INTERBROKER:PLAINTEXT,DOCKER:SASL_PLAINTEXT,LOCALHOST:SASL_PLAINTEXT
+KAFKA_CFG_CONTROLLER_QUORUM_VOTERS=0@broker:9094
+KAFKA_CFG_INTER_BROKER_LISTENER_NAME=DOCKER
+KAFKA_CFG_CONTROLLER_LISTENER_NAMES=CONTROLLER
+KAFKA_CFG_SASL_MECHANISM_CONTROLLER_PROTOCOL=PLAIN
+KAFKA_CFG_SASL_MECHANISM_INTER_BROKER_PROTOCOL=PLAIN
+KAFKA_CLIENT_USERS=data_rentgen
+KAFKA_CLIENT_PASSWORDS=changeme
+KAFKA_CFG_SASL_ENABLED_MECHANISMS=PLAIN,SCRAM-SHA-256
+
+# Common backend config
+DATA_RENTGEN__DATABASE__URL=postgresql+asyncpg://data_rentgen:changeme@db:5432/data_rentgen
+DATA_RENTGEN__LOGGING__PRESET=colored
+
+# See Backend -> Server -> Configuration documentation
+DATA_RENTGEN__SERVER__DEBUG=false
+
+# See Backend -> Consumer -> Configuration documentation
+DATA_RENTGEN__KAFKA__BOOTSTRAP_SERVERS=broker:9092
+DATA_RENTGEN__KAFKA__SECURITY__TYPE=scram-sha256
+DATA_RENTGEN__KAFKA__SECURITY__USER=data_rentgen
+DATA_RENTGEN__KAFKA__SECURITY__PASSWORD=changeme
+DATA_RENTGEN__KAFKA__COMPRESSION=zstd
+
+# See Frontend -> UI
+DATA_RENTGEN__UI__API_BROWSER_URL=http://localhost:8000
+
+# Session
+DATA_RENTGEN__SERVER__SESSION__SECRET_KEY=session_secret_key
+
+# Keycloak Auth
+DATA_RENTGEN__AUTH__KEYCLOAK__SERVER_URL=http://keycloak:8080
+DATA_RENTGEN__AUTH__KEYCLOAK__REALM_NAME=create_realm_manually
+DATA_RENTGEN__AUTH__KEYCLOAK__CLIENT_ID=create_client_manually
+DATA_RENTGEN__AUTH__KEYCLOAK__CLIENT_SECRET=generated_by_keycloak
+DATA_RENTGEN__AUTH__KEYCLOAK__REDIRECT_URI=http://localhost:8000/auth/callback
+DATA_RENTGEN__AUTH__KEYCLOAK__SCOPE=email
+DATA_RENTGEN__AUTH__KEYCLOAK__VERIFY_SSL=False
+DATA_RENTGEN__AUTH__PROVIDER=data_rentgen.server.providers.auth.keycloak_provider.KeycloakAuthProvider
+
+# Dummy Auth
+DATA_RENTGEN__AUTH__PROVIDER=data_rentgen.server.providers.auth.dummy_provider.DummyAuthProvider
+DATA_RENTGEN__AUTH__ACCESS_TOKEN__SECRET_KEY=secret

.env.local

@@ -1,4 +1,39 @@
-export ARRAKIS__DATABASE__URL=postgresql+asyncpg://arrakis:changeme@127.0.0.1:5432/arrakis
-export ARRAKIS__SERVER__DEBUG=true
-export ARRAKIS__SERVER__LOGGING__PRESET=colored
-export ARRAKIS_TEST_SERVER_URL=http://localhost:8000
+export DATA_RENTGEN__LOGGING__PRESET=colored
+
+export DATA_RENTGEN__DATABASE__URL=postgresql+asyncpg://data_rentgen:changeme@localhost:5432/data_rentgen
+
+export DATA_RENTGEN__KAFKA__BOOTSTRAP_SERVERS=localhost:9093
+export DATA_RENTGEN__KAFKA__SECURITY__TYPE=scram-sha256
+export DATA_RENTGEN__KAFKA__SECURITY__USER=data_rentgen
+export DATA_RENTGEN__KAFKA__SECURITY__PASSWORD=changeme
+export DATA_RENTGEN__KAFKA__COMPRESSION=zstd
+
+export DATA_RENTGEN__SERVER__DEBUG=true
+
+export DATA_RENTGEN__UI__API_BROWSER_URL=http://localhost:8000
+
+# Session
+export DATA_RENTGEN__SERVER__SESSION__SECRET_KEY=session_secret_key
+
+# Keycloak Auth
+export DATA_RENTGEN__AUTH__KEYCLOAK__SERVER_URL=http://localhost:8080
+export DATA_RENTGEN__AUTH__KEYCLOAK__REALM_NAME=create_realm_manually
+export DATA_RENTGEN__AUTH__KEYCLOAK__CLIENT_ID=create_client_manually
+export DATA_RENTGEN__AUTH__KEYCLOAK__CLIENT_SECRET=change_me
+export DATA_RENTGEN__AUTH__KEYCLOAK__REDIRECT_URI=http://localhost:3000/auth/callback
+export DATA_RENTGEN__AUTH__KEYCLOAK__SCOPE=email
+export DATA_RENTGEN__AUTH__KEYCLOAK__VERIFY_SSL=False
+export DATA_RENTGEN__AUTH__PROVIDER=data_rentgen.server.providers.auth.keycloak_provider.KeycloakAuthProvider
+
+# Dummy Auth
+export DATA_RENTGEN__AUTH__PROVIDER=data_rentgen.server.providers.auth.dummy_provider.DummyAuthProvider
+export DATA_RENTGEN__AUTH__ACCESS_TOKEN__SECRET_KEY=secret
+
+# Cors
+export DATA_RENTGEN__SERVER__CORS__ENABLED=True
+export DATA_RENTGEN__SERVER__CORS__ALLOW_ORIGINS=["http://localhost:3000"]
+export DATA_RENTGEN__SERVER__CORS__ALLOW_CREDENTIALS=true
+export DATA_RENTGEN__SERVER__CORS__ALLOW_METHODS=["*"]
+export DATA_RENTGEN__SERVER__CORS__ALLOW_HEADERS=["*"]
+export DATA_RENTGEN__SERVER__CORS__EXPOSE_HEADERS=["X-Request-ID", "Location", "Access-Control-Allow-Credentials"]
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 <!-- Thank you for your contribution! -->
 <!-- Unless your change is trivial, please create an issue to discuss the change before creating a PR -->
-<!-- See https://github.com/MobileTeleSystems/arrakis/blob/develop/CONTRIBUTING.rst for help on Contributing -->
+<!-- See https://github.com/MobileTeleSystems/data-rentgen/blob/develop/CONTRIBUTING.rst for help on Contributing -->
 <!-- PLEASE DO **NOT** put issue ids in the PR title! Instead, add a descriptive title and put ids in the body -->
 
 ## Change Summary
@@ -20,5 +20,5 @@
 * [ ] Tests pass on CI and coverage does not decrease
 * [ ] Documentation reflects the changes where applicable
 * [ ] `docs/changelog/next_release/<pull request or issue id>.<change type>.rst` file added describing change
-  (see [CONTRIBUTING.rst](https://github.com/MobileTeleSystems/arrakis/blob/develop/CONTRIBUTING.rst) for details.)
+  (see [CONTRIBUTING.rst](https://github.com/MobileTeleSystems/data-rentgen/blob/develop/CONTRIBUTING.rst) for details.)
 * [ ] My PR is ready to review.

.github/dependabot.yml

@@ -19,6 +19,11 @@ updates:
       interval: weekly
     labels:
       - type:dependency
+    ignore:
+      # https://github.com/sphinx-contrib/sphinxcontrib-towncrier/issues/92
+      - dependency-name: towncrier
+      # https://github.com/pydantic/pydantic/issues/10964
+      - dependency-name: pydantic
     # https://til.simonwillison.net/github/dependabot-python-setup
     groups:
       python-packages:

.github/labels.yml

@@ -14,9 +14,10 @@
     description: Add this label to skip changelog file check
     color: 04990f
 
-  - name: component:backend
-    description: Backend-related changes
+  - name: component:server
+    description: Server-related changes
     color: '5319e7'
+    from_name: component:backend
 
   - name: component:client
     description: Client-related changes

.github/workflows/codeql-analysis.yml

@@ -14,8 +14,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  # flake8-commas is failing on Python 3.12
-  DEFAULT_PYTHON: '3.11'
+  DEFAULT_PYTHON: '3.13'
 
 jobs:
   linters:
@@ -51,9 +50,39 @@ jobs:
       - name: Install dependencies
         run: |
           poetry install --no-root --all-extras --with dev --without docs,test
+          pip install -U flake8-commas
 
       - name: Run flake8
-        run: poetry run flake8 arrakis/
+        run: poetry run flake8 data_rentgen/
 
       - name: Run mypy
-        run: poetry run mypy ./arrakis --config-file ./pyproject.toml
+        run: poetry run mypy ./data_rentgen --config-file ./pyproject.toml
+
+
+  codeql:
+    name: CodeQL
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+    # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: python
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: /language:python

.github/workflows/dev-release.yml

@@ -0,0 +1,59 @@
+name: Dev release
+
+on:
+  push:
+    branches-ignore:
+      - dependabot/**
+      - pre-commit-ci-update-config
+      - master
+  workflow_dispatch:
+
+env:
+  DEFAULT_PYTHON: '3.13'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  wait-code-analysis:
+    name: Dev release package
+    runs-on: ubuntu-latest
+    if: github.repository == 'MobileTeleSystems/data-rentgen'  # prevent running on forks
+
+    environment:
+      name: test-pypi
+      url: https://test.pypi.org/p/data-rentgen
+    permissions:
+      id-token: write # to auth in Test PyPI
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.DEFAULT_PYTHON }}
+        id: python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.DEFAULT_PYTHON }}
+
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+
+      - name: Generate unique version and update test version
+        run: |
+          poetry self add poetry-bumpversion
+          version=$(poetry version -s)
+          poetry version "${version}.dev${GITHUB_RUN_ID}"
+
+      - name: Fix logo in Readme
+        run: |
+          sed -i "s#image:: docs/#image:: https://raw.githubusercontent.com/MobileTeleSystems/data-rentgen/$GITHUB_SHA/docs/#g" README.rst
+
+      - name: Build package
+        run: poetry build
+
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/image_release.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - develop
+    tags:
+      - v[0-9]+.[0-9]+.[0-9]+
+
+jobs:
+  release:
+    name: Build & push image to Dockerhub
+    runs-on: ubuntu-latest
+    if: github.repository == 'MobileTeleSystems/data-rentgen'
+
+    steps:
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set tag
+        id: set_tag
+        run: |
+          if [[ "${{ github.ref_type }}" == "branch" && "${{ github.ref_name }}" == "develop" ]]; then
+            echo "TAG=mtsrus/data-rentgen:develop" >> $GITHUB_ENV
+          elif [[ "${{ github.ref_type }}" == "tag" ]]; then
+            echo "TAG=mtsrus/data-rentgen:latest,mtsrus/data-rentgen:${{ github.ref_name }}" >> $GITHUB_ENV
+          fi
+
+      - name: Build Backend Image
+        uses: docker/build-push-action@v6
+        with:
+          tags: ${{ env.TAG }}
+          context: .
+          file: docker/Dockerfile
+          pull: true
+          push: true
+          cache-to: type=gha,mode=max
+          cache-from: type=gha
+          platforms: |
+            linux/amd64
+            linux/arm64/v8
+          provenance: mode=max
+