Laudatory Larkspurs

laudatory-larkspurs/.github/workflows/build.yaml

@@ -0,0 +1,84 @@
+name: Build project and publish
+
+on:
+    push:
+        branches: [main]
+    workflow_dispatch:
+
+concurrency:
+    group: build-${{ github.ref }}
+    cancel-in-progress: true
+
+permissions:
+    contents: write
+
+jobs:
+    build:
+        name: Build the project
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Set up Python
+              uses: actions/setup-python@v5
+              with:
+                  python-version: "3.12"
+
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install .
+
+            - name: Build project
+              run: python build.py
+
+            - name: Upload build artifact
+              uses: actions/upload-artifact@v4
+              with:
+                  name: build
+                  path: build
+                  if-no-files-found: error
+
+    publish:
+        name: Publish build artifact
+        needs: build
+        runs-on: ubuntu-latest
+        if: github.ref == 'refs/heads/main'
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            - name: Configure Git
+              run: |
+                  BOT_NAME="github-actions[bot]"
+                  BOT_EMAIL="41898282+github-actions[bot]@users.noreply.github.com"
+                  git config user.name "$BOT_NAME"
+                  git config user.email "$BOT_EMAIL"
+
+            - name: Prepare build branch
+              run: |
+                  set -e
+                  if git ls-remote --exit-code origin build; then
+                    git fetch origin build:build
+                    git checkout build
+                  else
+                    git checkout --orphan build
+                  fi
+                  find . -mindepth 1 -maxdepth 1 ! -name '.git' -exec rm -rf {} +
+
+            - name: Download build artifact
+              uses: actions/download-artifact@v4
+              with:
+                  name: build
+                  path: .
+
+            - name: Commit build folder
+              run: |
+                  git add .
+                  git diff --cached --quiet && echo "No build changes to commit" || git commit -m "Deploying production from @ ${GITHUB_SHA::7} 🚀"
+                  git push origin build
+
+        timeout-minutes: 15

laudatory-larkspurs/.github/workflows/deploy.yaml

@@ -0,0 +1,42 @@
+name: Deploy to Vercel
+
+on:
+    workflow_run:
+        workflows: ["Build project and publish"]
+        branches: [main]
+        types: [completed]
+    workflow_dispatch:
+
+env:
+    VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+    VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+
+concurrency:
+    group: deploy-${{ github.ref }}
+    cancel-in-progress: true
+
+jobs:
+    deploy:
+        name: Deploy production build
+        if: ${{ github.event_name == 'workflow_dispatch' || (github.event.workflow_run && github.event.workflow_run.conclusion == 'success') }}
+        runs-on: ubuntu-latest
+        environment: production
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  ref: build
+
+            - name: Set up Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: "22"
+
+            - name: Install Vercel CLI
+              run: npm install -g vercel@latest
+
+            - name: Deploy to Vercel
+              run: vercel deploy --prod --yes --token=${{ secrets.VERCEL_TOKEN }}
+
+        timeout-minutes: 15

laudatory-larkspurs/.github/workflows/lint.yaml

@@ -0,0 +1,35 @@
+# GitHub Action workflow enforcing our code style.
+
+name: Lint
+
+# Trigger the workflow on both push (to the main repository, on the main branch)
+# and pull requests (against the main repository, but from any repo, from any branch).
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+# Brand new concurrency setting! This ensures that not more than one run can be triggered for the same commit.
+# It is useful for pull requests coming from the main repository since both triggers will match.
+concurrency: lint-${{ github.sha }}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    env:
+      # The Python version your project uses. Feel free to change this if required.
+      PYTHON_VERSION: "3.12"
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ env.PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: Run pre-commit hooks
+        uses: pre-commit/action@v3.0.1

laudatory-larkspurs/.gitignore

@@ -0,0 +1,34 @@
+# Files generated by the interpreter
+__pycache__/
+*.py[cod]
+
+# Environment specific
+.venv
+venv
+.env
+env
+
+# Unittest reports
+.coverage*
+
+# Logs
+*.log
+
+# PyEnv version selector
+.python-version
+
+# Built objects
+*.so
+dist/
+build/
+
+# IDEs
+# PyCharm
+.idea/
+# VSCode
+.vscode/
+# MacOS
+.DS_Store
+
+build/
+.vercel

laudatory-larkspurs/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+# Pre-commit configuration.
+# See https://github.com/python-discord/code-jam-template/tree/main#pre-commit-run-linting-before-committing
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.2
+    hooks:
+      - id: ruff-check
+      - id: ruff-format

laudatory-larkspurs/CONTRIBUTING.md

@@ -0,0 +1,141 @@
+# Contributing
+
+## Information
+
+This project uses [Pyodide](https://pyodide.org) to run Python directly in the browser using WebAssembly (WASM).  
+Almost no JavaScript is required — the frontend is written entirely in Python and HTML/CSS.
+
+## Dev Code Checks
+
+Use `ruff check` to check your code style. and fix it
+
+```shell
+ruff check .
+ruff check . --fix
+```
+
+Use `pre-commit` to run linting before committing. `pre-commit install` to install.
+
+### Examples
+
+```shell
+pre-commit run --show-diff-on-failure --all-files
+pre-commit run ruff-check --all-files
+pre-commit run check-toml --all-files
+```
+
+**Pre-commit hooks:**
+
+- `check-toml`: Lints and corrects your TOML files.
+- `check-yaml`: Lints and corrects your YAML files.
+- `end-of-file-fixer`: Makes sure you always have an empty line at the end of your file.
+- `trailing-whitespace`: Removes whitespaces at the end of each line.
+- `ruff-check`: Runs the Ruff linter.
+- `ruff-format`: Runs the Ruff formatter.
+
+## Our coding rules
+
+1. Comment your classes, functions, and non-obvious logic.
+2. Use docstrings with author tags and short descriptions.
+
+```py
+class ClassName:
+    '''Handle user input and validation.
+
+    @author Mira
+    '''
+    ...
+
+# Short function description
+def do_something():
+    '''Perform a single-step operation.
+
+    :param paramname: does something
+    :return: None
+
+    @author Mira
+    '''
+    ...
+```
+
+## Naming Stuff Rules
+
+Use `ruff check` to check your code style. and fix it
+
+```shell
+ruff check .
+ruff check . --fix
+```
+
+**Functions**: lowercase and use underscores
+
+```py
+def my_function():
+    my_variable = "value"
+```
+
+**Classes and Variable names**: PascalCase style
+
+```py
+from typing import List
+
+class MyClass:
+    pass
+
+ListOfMyClass = List[MyClass]
+```
+
+**Constants**: SCREAMING_SNAKE_CASE style
+
+```py
+MY_CONSTANT = 1
+```
+
+**Operators**: at the start of a newline
+
+```py
+# No
+result = (
+    1 +
+    2 *
+    3
+)
+# Yes
+result = (
+    1
+    + 2
+    * 3
+)
+```
+
+**equivalent to None**: use `is`, `is not` instead of `==`
+
+```py
+if variable == None: # No
+    print("Variable is None")
+if variable is None: # Yes
+    print("Variable is None")¨
+```
+
+**not** positioning:
+
+```py
+if not variable is None: # No
+    print("Variable is not None")
+
+if variable is not None: # Yes, easier to read
+    print("Variable is not None")
+```
+
+**Imports**: do not import multiple modules on one line or everything from a module (\*)
+
+```py
+# No
+import pathlib, os
+from pathlib import *
+
+# Yes
+import os
+import pathlib
+from pathlib import Path
+```

laudatory-larkspurs/Dockerfile

@@ -0,0 +1,33 @@
+#############################
+# Single-stage Python image #
+#############################
+FROM python:3.12-slim
+
+LABEL org.opencontainers.image.title="good-image-terminal" \
+	  org.opencontainers.image.description="A simple yet interesting image editor." \
+	  org.opencontainers.image.licenses="MIT"
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+	PYTHONUNBUFFERED=1 \
+	PORT=8000
+
+# Set the working directory
+WORKDIR /app
+
+# Copy project files
+COPY build.py pyproject.toml README.md uv.lock* ./
+RUN pip install --no-cache-dir .
+
+COPY public ./public
+COPY src ./src
+
+EXPOSE 8000
+
+CMD ["bash", "-c", "python build.py --serve --port ${PORT}"]
+
+#####################################################################################################
+# Usage                                                                                             #
+#   docker build -t good-image-terminal:latest .                                                    #
+#   docker run --rm --name good-image-terminal -e PORT=8000 -p 8000:8000 good-image-terminal:latest #
+# App: http://localhost:8000                                                                        #
+#####################################################################################################