Feat/initial dev

.github/setup/action.yml

@@ -0,0 +1,37 @@
+name: Setup Step
+
+description: |
+  This step sets up Python and Poetry, and caches the virtual environment.
+  It is intended to be used as a step in a workflow that runs Python code.
+
+inputs:
+  python-version:
+    required: true
+    description: "Python version to use with `actions/setup-python`"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Set up Poetry
+      shell: bash
+      run: |
+        python -m pip install --upgrade pip poetry
+        poetry self add "poetry-dynamic-versioning[plugin]"
+        poetry config virtualenvs.create true --local
+        poetry config virtualenvs.in-project true --local
+
+    - name: Use venv cache
+      uses: actions/cache@v3
+      with:
+        path: ./.venv
+        key: venv-${{ hashFiles('poetry.lock') }}-${{ inputs.python-version }}
+
+    - name: Install project
+      shell: bash
+      run: |
+        poetry --no-ansi --no-interaction install

.github/workflows/build-image.yml

@@ -0,0 +1,56 @@
+name: Build Image
+
+on:
+  push:
+    tags:
+      - "v**"
+  workflow_call:
+  workflow_dispatch:
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=semver,pattern={{major}}
+            type=sha
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/lint.yml

@@ -0,0 +1,40 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+
+      - uses: ./.github/setup
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Lint - ruff
+        if: always()
+        run: poetry run poe ruff
+
+      - name: Lint - black
+        if: always()
+        run: poetry run poe black --check
+
+      - name: Lint - mypy
+        if: always()
+        run: poetry run poe mypy
+
+      - name: Lint - pyright
+        if: always()
+        run: poetry run poe pyright

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12-dev"]
+    steps:
+      - name: Checkout project
+        uses: actions/checkout@v3
+
+      - uses: ./.github/setup
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Test
+        run: poetry run poe test
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  build-image:
+    needs: test
+    uses: ./.github/workflows/build-image.yml
+    permissions:
+      contents: read
+      packages: write
+    secrets: inherit

.gitignore

@@ -1,4 +1,7 @@
+.env
 zuliprc
+clients.json
+src/zulip_write_only_proxy/_version.py
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

.pre-commit-config.yaml

@@ -0,0 +1,8 @@
+repos:
+- hooks:
+  - id: commitizen
+  - id: commitizen-branch
+    stages:
+    - push
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v2.42.1

Dockerfile

@@ -0,0 +1,20 @@
+FROM python:3.11
+
+WORKDIR /app
+
+RUN --mount=type=cache,target=/root/.cache \
+    python3 -m pip install --upgrade poetry pip
+
+COPY ./poetry.lock ./pyproject.toml ./README.md /app
+COPY ./src /app/src
+
+RUN poetry config virtualenvs.create false --local
+
+RUN --mount=type=cache,target=/root/.cache\
+    poetry install
+
+CMD ["uvicorn", "zulip_write_only_proxy.main:app", "--host", "0.0.0.0", "--port", "8080"]
+
+EXPOSE 8080
+
+HEALTHCHECK CMD curl --fail http://localhost:8080/health || exit 1

Makefile

@@ -0,0 +1,11 @@
+up:
+	git pull
+	# See: https://github.com/docker/cli/issues/1073
+	docker compose config | sed '/published:/ s/"//g' | sed "/name:/d" | docker stack deploy -c - zwop
+
+down:
+	docker stack rm zwop
+
+dev-docker:
+	docker build . --tag zwop:dev
+	docker run -it --rm -v $(PWD):/app -p 8080:8080 zwop:dev