🎉 initial commit

Author: krmax44

.github/workflows/docs.yaml

@@ -0,0 +1,35 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+      contents: read
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: "3.13"
+          activate-environment: true
+      - name: Install dependencies
+        run: uv sync
+      - run: pdoc --output-dir docs/ vue_ssr
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+      - uses: actions/deploy-pages@v4
+

.github/workflows/test.yaml

@@ -0,0 +1,56 @@
+name: Test
+
+on: push
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+      - uses: pre-commit/[email protected]
+      
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.13']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+          activate-environment: true
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
+          cache-dependency-path: 'test/frontend/pnpm-lock.yaml'
+      - name: Install JS dependencies
+        run: pnpm install
+        working-directory: test/frontend
+      - name: Install Python dependencies
+        run: uv sync
+      - name: Build frontend
+        run: pnpm run build
+        working-directory: test/frontend
+      - name: Collect static files
+        run: python manage.py collectstatic --noinput
+      - name: Run tests
+        run: |
+          coverage run -m pytest
+          coverage report --format=markdown >> $GITHUB_STEP_SUMMARY
+
+  

.gitignore

@@ -0,0 +1,29 @@
+# Python
+.venv
+*.egg-info
+
+# Django
+db.sqlite3
+static
+public
+
+# coverage
+.coverage
+htmlcov
+
+# testing
+*.sock
+
+# caches
+__pycache__
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+
+# Node.js
+dist
+build
+node_modules

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.2
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 krmax44
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include LICENSE

README.md

@@ -0,0 +1,37 @@
+# Vue Server-Side Rendering in Python
+
+Client for [`vue-ssr-service`](https://github.com/krmax44/vue-ssr-service). See its documentation for a [quick start guide](https://github.com/krmax44/vue-ssr-service#getting-started-with-vite).
+
+## Stand-alone
+
+```python
+from vue_ssr import ServerRenderer
+
+renderer = ServerRenderer()
+renderer.render("myComponent", props={"name": "friend"})
+# "<p>Hello, friend!</p>"
+```
+
+## With Django
+
+Works well in conjunction with [`django-vite`](https://github.com/MrBin99/django-vite). Add it to your installed apps:
+
+```py
+INSTALLED_APPS = [
+  "vue_ssr",
+  ...
+]
+```
+
+Then, you can simply use the provided template tag:
+
+```django
+{% load vue_ssr %}
+<user-greeting>{% render_vue "userGreeting" name=request.user.username %}</user-greeting>
+```
+
+Or pass a dict with props:
+
+```django
+<my-app>{% render_vue "myApp" props=props %}</my-app>
+```

manage.py

@@ -0,0 +1,23 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name = "vue-ssr"
+version = "0.1.0"
+description = "Render Vue components on the server side"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["requests>=2.0.0", "requests-unixsocket>=0.4.1"]
+
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["vue_ssr"]
+
+[tool.ruff.lint]
+extend-select = ["I001"]
+
+[tool.ruff.lint.isort]
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder",
+]
+default-section = "third-party"
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "test.settings"
+python_files = ["test_*.py"]
+timeout = 10
+
+[tool.coverage.run]
+source = ["vue_ssr"]
+omit = ["*/wsgi.py", "*/asgi.py"]
+branch = true
+
+[dependency-groups]
+dev = [
+    "coverage[toml]>=7.8.0",
+    "django>=5.2.1",
+    "django-vite>=3.1.0",
+    "pdoc>=15.0.3",
+    "pytest>=8.3.5",
+    "pytest-django>=4.11.1",
+    "pytest-timeout>=2.4.0",
+    "ruff>=0.11.10",
+]

test/__init__.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for example project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/5.1/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test.settings")
+
+application = get_asgi_application()