Rebase from original zou

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: EvanBldy
+
+---
+
+**Context**
+
+Studio name: 
+Zou version: 
+Zou installation type: (for example: hosted by CGWire, self-hosted, docker etc)
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,10 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: EvanBldy
+
+---
+
+Please use https://cgwire.canny.io for any big feature request.

.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+---
+name: Zou CI
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    name: Test with different versions of Python 🐍
+    runs-on: ubuntu-latest
+    env:
+      INDEXER_KEY: testkey0123456789
+      PGPASSWORD: mysecretpassword
+    strategy:
+      fail-fast: false
+      matrix:
+        version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    services:
+      postgres:
+        image: "postgres:12.16"
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: ${{ env.PGPASSWORD }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install ffmpeg
+        run: |
+          sudo apt-get update
+          sudo apt install -y ffmpeg
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.version }}
+          cache: pip
+      - name: Upgrade pip 📦
+        run: >-
+          pip install --upgrade pip setuptools
+      - name: Install packages 📦
+        run: >-
+          pip install -r requirements.txt
+      - name: Create database 🗄
+        run: >-
+          psql -c 'create database zoudb;' -U postgres -h 127.0.0.1
+      - name: Launch docker for meilisearch 🐳
+        run: |
+          docker pull getmeili/meilisearch:v1.1
+          docker run -it --rm -d -p 7700:7700 -e MEILI_MASTER_KEY=$INDEXER_KEY getmeili/meilisearch:v1.1
+      - name: Run tests 🧪
+        run: >-
+          py.test
+        env:
+          DEBUG: 1
+          MAIL_DEBUG_BODY: 1
+          MAIL_ENABLED: False

.github/workflows/main.yml

@@ -1,27 +1,50 @@
-name: Deploy Zou to staging environment
+name: Deploy Zou to staging environment and update apidocs
 
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   build:
+    if: github.repository_owner == 'cgwire'
     name: Build
     runs-on: ubuntu-latest
     steps:
-    - name: Update Zou on staging server
-      uses: appleboy/ssh-action@master
-      with:
-       host: ${{ secrets.HOST }}
-       username: ${{ secrets.USERNAME }}
-       key: ${{ secrets.KEY }}
-       port: ${{ secrets.PORT }}
-       script_stop: true
-       script: |
-         cd /opt/zou
-         . zouenv/bin/activate
-         source /etc/zou/zou.env
-         pip install --upgrade git+https://github.com/cgwire/zou.git
-         zou upgrade_db
-         sudo service zou restart
+      - name: Update Zou on staging server
+        uses: appleboy/[email protected]
+        with:
+          host: ${{ secrets.HOST }}
+          username: ${{ secrets.USERNAME }}
+          key: ${{ secrets.KEY }}
+          port: ${{ secrets.PORT }}
+          script_stop: true
+          script: |
+            cd /opt/zou
+            source /etc/zou/zou.env
+            sudo /opt/zou/zouenv/bin/pip uninstall -y zou
+            sudo /opt/zou/zouenv/bin/pip install --upgrade git+https://github.com/cgwire/zou.git
+            sudo -E -u zou /opt/zou/zouenv/bin/zou upgrade-db
+            sudo systemctl restart zou zou-events zou-jobs
+      - uses: actions/checkout@v4
+        with:
+          ref: apidocs
+      - name: Update openapi.json
+        run: |
+          cd docs
+          curl --output openapi.json https://kitsu-staging.cg-wire.com/api/openapi.json
+          git config --global user.email "[email protected]"
+          git config --global user.name "CGWire bot"
+          git add openapi.json || false
+          git commit -m "Update openapi.json" || true
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: apidocs
+      - name: Push on bump.sh
+        uses: bump-sh/github-action@v1
+        with:
+          doc: kitsu-api
+          token: ${{secrets.BUMP_TOKEN}}
+          file: docs/openapi.json

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Build package and deploy on PyPi
+
+on: [push, pull_request]
+
+jobs:
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+      - name: Install pypa/build
+        run: >-
+          python3 -m
+          pip install
+          build
+          --user
+      - name: Build a binary wheel
+        run: >-
+          python3 -m
+          build
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

.gitignore

@@ -92,9 +92,12 @@ ENV/
 Vagrantfile
 .vagrant
 
-previews
-thumbnails
-release.sh
+/previews/
+/thumbnails/
+/indexes/
 
 tmp
 restore.sh
+
+# Meilisearch folder
+data.ms

.pre-commit-config.yaml

@@ -1,10 +1,16 @@
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
     hooks:
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/psf/black
-    rev: 21.8b0
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 24.8.0
     hooks:
-    -   id: black
+      - id: black
+  - repo: https://github.com/PyCQA/autoflake
+    rev: v2.3.1
+    hooks:
+      - id: autoflake
+        args:
+          [--remove-all-unused-imports, --remove-unused-variables, --in-place]

.pre-commit-hooks.yaml

@@ -3,6 +3,6 @@
   description: "Black: The uncompromising Python code formatter"
   entry: black
   language: python
-  minimum_pre_commit_version: 2.9.2
+  minimum_pre_commit_version: 3.8.0
   require_serial: true
   types_or: [python, pyi]

.vscode/launch.json

@@ -1,23 +1,57 @@
 {
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Python: Flask",
-            "type": "python",
-            "request": "launch",
-            "module": "flask",
-            "env": {
-                "FLASK_APP": "zou.app",
-                "FLASK_DEBUG": "1",
-                "PREVIEW_FOLDER": "$PWD/previews",
-                "DEBUG": "1",
-                "MAIL_DEBUG": "1",
-            },
-            "args": [
-                "run",
-                "--no-reload",
-            ],
-            "jinja": true
-        }
-    ]
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python: Flask",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "flask",
+      "env": {
+        "FLASK_APP": "zou.app",
+        "FLASK_DEBUG": "1",
+        "DEBUG": "1",
+        "MAIL_DEBUG_BODY": "1",
+        "MAIL_ENABLED": "False"
+      },
+      "args": ["run", "--no-reload"],
+      "jinja": true,
+      "justMyCode": false
+    },
+    {
+      "name": "Python: Current File",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${file}",
+      "console": "integratedTerminal",
+      "cwd": "${workspaceFolder}",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}${pathSeparator}${env:PYTHONPATH}"
+      },
+      "justMyCode": false
+    },
+    {
+      "name": "Python: Test current File",
+      "type": "debugpy",
+      "request": "launch",
+      "module": "pytest",
+      "args": ["${file}"],
+      "cwd": "${workspaceFolder}",
+      "env": { "DB_DATABASE": "zoudbtest" },
+      "justMyCode": false
+    },
+    {
+      "name": "Python: Real Time",
+      "type": "debugpy",
+      "request": "launch",
+      "program": "${workspaceFolder}/zou/event_stream.py",
+      "console": "integratedTerminal",
+      "cwd": "${fileDirname}",
+      "env": {
+        "PYTHONPATH": "${workspaceFolder}${pathSeparator}${env:PYTHONPATH}",
+        "DEBUG": "1"
+      },
+      "gevent": true,
+      "justMyCode": false
+    }
+  ]
 }

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter"
+  }
+}