uEdition-Editor 2.0.0b21__tar.gz

uedition_editor-2.0.0b21/.gitignore

@@ -0,0 +1,5 @@
+.coverage*
+dist
+.env
+__pycache__
+tmp

uedition_editor-2.0.0b21/.pre-commit-config.yaml

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

uedition_editor-2.0.0b21/Containerfile

@@ -0,0 +1,16 @@
+FROM python:3.13-bookworm
+
+RUN useradd -u 1000 -g 100 -d /etc/ueditor -m ueditor
+
+RUN apt-get update && \
+    apt-get dist-upgrade -y && \
+    apt-get install -y tini
+
+COPY dist/*.whl /tmp/uedition-editor-source/
+
+RUN pip install /tmp/uedition-editor-source/*.whl
+
+USER ueditor
+
+ENTRYPOINT ["/usr/bin/tini", "--"]
+CMD [ "uvicorn", "--port", "8000", "--host", "0.0.0.0", "uedition_editor:app" ]

uedition_editor-2.0.0b21/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Mark Hall <mark.hall@work.room3b.eu>
+
+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.

uedition_editor-2.0.0b21/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: uEdition-Editor
+Version: 2.0.0b21
+Project-URL: Documentation, https://github.com/uEdition/uEditor#readme
+Project-URL: Issues, https://github.com/uEdition/uEditor/issues
+Project-URL: Source, https://github.com/uEdition/uEditor
+Author-email: Mark Hall <mark.hall@work.room3b.eu>
+License-Expression: MIT
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.11
+Requires-Dist: aiocron<3,>=2.1
+Requires-Dist: fastapi<1
+Requires-Dist: httptools<1
+Requires-Dist: httpx<1,>=0.28.1
+Requires-Dist: lxml<7,>=5
+Requires-Dist: pydantic-settings<3,>=2
+Requires-Dist: pydantic[email]<3,>=2
+Requires-Dist: pygit2<2,>=1.17.0
+Requires-Dist: pyjwt[crypto]<3,>=2.10.1
+Requires-Dist: python-multipart<1,>=0.0.9
+Requires-Dist: python-slugify<9,>=8.0.4
+Requires-Dist: pyyaml-include<3,>=2
+Requires-Dist: pyyaml<7,>=6
+Requires-Dist: typer<1,>=0.15.1
+Requires-Dist: uedition<2.1,>=2.0.0b5
+Requires-Dist: uvicorn<1
+Requires-Dist: uvloop<1
+Requires-Dist: websockets<17,>=15
+Description-Content-Type: text/markdown
+
+# μEditor
+
+[![PyPI - Version](https://img.shields.io/pypi/v/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
+[![Test workflow status](https://github.com/uEdition/uEditor/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)
+[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/5e5b6cc511c2b9d625cba7bf9857a820/raw/coverage.json)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)
+
+---
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Installation
+
+The simplest way to install the μEditor is using [pipx](https://github.com/pypa/pipx). Install pipx for your
+operating system and then run the following command to install the μEditor:
+
+```console
+pipx install "uedition-editor>=2.0.0b2,<3"
+```
+
+Then run the following command to start the μEditor:
+
+```console
+UEDITOR__BASE_DIR=path/to/where/your/files/are ueditor server
+```
+
+The μEditor is then available at http://localhost:8000.
+
+## Documentation
+
+Documentation to come soon.
+
+## License
+
+`ueditor` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition_editor-2.0.0b21/README.md

@@ -0,0 +1,39 @@
+# μEditor
+
+[![PyPI - Version](https://img.shields.io/pypi/v/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
+[![Test workflow status](https://github.com/uEdition/uEditor/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)
+[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/5e5b6cc511c2b9d625cba7bf9857a820/raw/coverage.json)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)
+
+---
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [Documentation](#documentation)
+- [License](#license)
+
+## Installation
+
+The simplest way to install the μEditor is using [pipx](https://github.com/pypa/pipx). Install pipx for your
+operating system and then run the following command to install the μEditor:
+
+```console
+pipx install "uedition-editor>=2.0.0b2,<3"
+```
+
+Then run the following command to start the μEditor:
+
+```console
+UEDITOR__BASE_DIR=path/to/where/your/files/are ueditor server
+```
+
+The μEditor is then available at http://localhost:8000.
+
+## Documentation
+
+Documentation to come soon.
+
+## License
+
+`ueditor` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

uedition_editor-2.0.0b21/pyproject.toml

@@ -0,0 +1,189 @@
+[build-system]
+requires = ["hatchling", "hatch-build-scripts"]
+build-backend = "hatchling.build"
+
+[project]
+name = "uEdition-Editor"
+dynamic = ["version"]
+description = ''
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+keywords = []
+authors = [{ name = "Mark Hall", email = "mark.hall@work.room3b.eu" }]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = [
+  "aiocron>=2.1,<3",
+  "fastapi<1",
+  "httptools<1",
+  "httpx>=0.28.1,<1",
+  "lxml>=5,<7",
+  "pydantic[email]>=2,<3",
+  "pydantic_settings>=2,<3",
+  "pygit2>=1.17.0,<2",
+  "python-multipart>=0.0.9,<1",
+  "python-slugify>=8.0.4,<9",
+  "pyjwt[crypto]>=2.10.1,<3",
+  "PyYaml>=6,<7",
+  "pyyaml_include>=2,<3",
+  "uEdition>=2.0.0b5,<2.1",
+  "typer>=0.15.1,<1",
+  "uvicorn<1",
+  "uvloop<1",
+  "websockets>=15,<17",
+]
+
+[project.urls]
+Documentation = "https://github.com/uEdition/uEditor#readme"
+Issues = "https://github.com/uEdition/uEditor/issues"
+Source = "https://github.com/uEdition/uEditor"
+
+[project.scripts]
+ueditor = "uedition_editor.cli:app"
+
+[tool.hatch.version]
+path = "uedition_editor/__about__.py"
+
+[tool.hatch.build.targets.sdist]
+artifacts = ["uedition_editor/frontend/dist/**/*"]
+exclude = [
+  ".github",
+  "dev",
+  "docs",
+  "tests",
+  ".pre-config-config.yaml",
+  ".readthedocs.yml",
+  "uedition_editor/frontend",
+]
+
+[tool.hatch.build.targets.wheel]
+artifacts = ["uedition_editor/frontend/dist/**/*"]
+exclude = [
+  ".github",
+  "dev",
+  "docs",
+  "tests",
+  ".pre-config-config.yaml",
+  ".readthedocs.yml",
+  "uedition_editor/frontend",
+]
+
+[[tool.hatch.build.hooks.build-scripts.scripts]]
+artifacts = []
+commands = ["npm ci", "npm run build"]
+work_dir = "uedition_editor/frontend"
+out_dir = "tmp"
+
+[tool.hatch.envs.default]
+extra-dependencies = ["coverage[toml]>=6.5", "httpx", "pytest", "ruff==0.9.5"]
+
+[tool.hatch.envs.default.scripts]
+server = "uvicorn --reload --port 8000 uedition_editor:app {args}"
+frontend-server = "cd uedition_editor/frontend && npm install && vite"
+build-frontend = "cd uedition_editor/frontend && npm install && vite build"
+
+# Test commands
+e2e-tests = "cd tests/e2e_tests && UEDITOR__BASE_PATH=./tmp_fixtures UEDITOR__TEST=true UEDITOR__AUTH__PROVIDER=no-auth UEDITOR__AUTH__EMAIL= UEDITOR__AUTH__NAME= npx playwright test"
+test = "UEDITOR__BASE_PATH=./tmp_fixtures UEDITOR__TEST=true UEDITOR__AUTH__PROVIDER=no-auth UEDITOR__AUTH__EMAIL= UEDITOR__AUTH__NAME=  pytest {args:tests}"
+test-cov = "UEDITOR__BASE_PATH=./tmp_fixtures UEDITOR__TEST=true UEDITOR__AUTH__PROVIDER=no-auth UEDITOR__AUTH__EMAIL= UEDITOR__AUTH__NAME=  coverage run -m pytest {args:tests}"
+cov-report = ["- coverage combine", "coverage report"]
+cov = ["test-cov", "cov-report"]
+
+# Style commands
+style = [
+  "ruff check --fix --exit-non-zero-on-fix {args:.}",
+  "ruff format --check {args:.}",
+]
+
+# Release commands
+update-version = "hatch run python update_version.py"
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+  "A",
+  "ARG",
+  "B",
+  "C",
+  "D",
+  "DTZ",
+  "E",
+  "EM",
+  "F",
+  "FBT",
+  "I",
+  "ICN",
+  "ISC",
+  "N",
+  "PLC",
+  "PLE",
+  "PLR",
+  "PLW",
+  "Q",
+  "RUF",
+  "S",
+  "T",
+  "TID",
+  "UP",
+  "W",
+  "YTT",
+]
+ignore = [
+  # Allow non-abstract empty methods in abstract base classes
+  "B027",
+  # Allow boolean positional values in function calls, like `dict.get(... True)`
+  "FBT003",
+  # Ignore checks for possible passwords
+  "S105",
+  "S106",
+  "S107",
+  # Ignore complexity
+  "C901",
+  "PLR0911",
+  "PLR0912",
+  "PLR0913",
+  "PLR0915",
+  # Pydocstyle settings
+  "D203",
+  "D212",
+]
+unfixable = [
+  # Don't touch unused imports
+  "F401",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["uedition_editor"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.per-file-ignores]
+# Tests can use magic values, assertions, and relative imports
+"tests/**/*" = ["PLR2004", "S101", "TID252"]
+
+[tool.coverage.run]
+source_pkgs = ["uedition_editor"]
+branch = true
+parallel = true
+omit = ["uedition_editor/__about__.py"]
+
+[tool.coverage.paths]
+uedition_editor = ["uedition_editor", "*/uedition_editor/uedition_editor"]
+tests = ["tests", "*/uedition_editor/tests"]
+
+[tool.coverage.report]
+exclude_lines = ["no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:"]
+skip_covered = true
+show_missing = true

uedition_editor-2.0.0b21/uedition_editor/__about__.py

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2024-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""About this package."""
+
+__version__ = "2.0.0b21"

uedition_editor-2.0.0b21/uedition_editor/__init__.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2024-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The main uEditor server."""
+
+import logging
+from contextlib import asynccontextmanager
+from copy import deepcopy
+
+from fastapi import FastAPI
+from fastapi.exceptions import HTTPException
+from fastapi.responses import RedirectResponse, Response
+from fastapi.staticfiles import StaticFiles
+from httpx import AsyncClient
+from uvicorn.config import LOGGING_CONFIG
+
+from uedition_editor import cron
+from uedition_editor.api import router as api_router
+from uedition_editor.settings import init_settings
+
+logger = logging.getLogger(__name__)
+# Configure logging
+conf = deepcopy(LOGGING_CONFIG)
+conf["loggers"]["uedition_editor"] = {
+    "level": logging.INFO,
+    "qualname": "uedition_editor",
+    "handlers": ["default"],
+}
+conf["formatters"]["default"]["fmt"] = "%(levelprefix)s %(name)-40s %(message)s"
+conf["root"] = {"level": logging.INFO}
+if init_settings.test:  # pragma: no cover
+    conf["loggers"]["uedition_editor"]["level"] = logging.DEBUG
+logging.config.dictConfig(conf)
+logger.debug("Logging configuration set up")
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):  # noqa:ARG001
+    """Startup/shutdown handler."""
+    await cron.track_branches.func()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+app.include_router(api_router)
+
+if init_settings.dev:
+
+    @app.get("/app/{path:path}")
+    async def ui_dev(path: str):
+        """Proxy the development frontend server."""
+        async with AsyncClient() as client:
+            response = await client.get(f"http://localhost:5173/app/{path}")
+            if response.status_code == 200:  # noqa:PLR2004
+                return Response(content=response.content, media_type=response.headers["Content-Type"])
+            else:
+                raise HTTPException(response.status_code)
+
+else:
+    app.mount("/app", StaticFiles(packages=[("uedition_editor", "frontend/dist")], html=True))
+
+
+@app.get("/", response_class=RedirectResponse)
+def redirect_to_app(timestamp: int | None = None):
+    """Redirect to the application UI."""
+    if timestamp is not None:
+        return f"/app/?timestamp={timestamp}"
+    else:
+        return "/app/"

uedition_editor-2.0.0b21/uedition_editor/__main__.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2024-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The uEditor module entry point."""
+
+from uedition_editor.cli import app
+
+if __name__ == "__main__":
+    app()

uedition_editor-2.0.0b21/uedition_editor/api/__init__.py

@@ -0,0 +1,72 @@
+# SPDX-FileCopyrightText: 2024-present Mark Hall <mark.hall@work.room3b.eu>
+#
+# SPDX-License-Identifier: MIT
+"""The uEditor server API."""
+
+from typing import Literal
+
+from fastapi import APIRouter
+from pydantic import BaseModel
+from pygit2 import GitError, Repository
+from pygit2.enums import RepositoryOpenFlag
+
+from uedition_editor.__about__ import __version__
+from uedition_editor.api.auth import router as auth_router
+from uedition_editor.api.branches import router as branches_router
+from uedition_editor.settings import init_settings
+
+router = APIRouter(prefix="/api")
+router.include_router(auth_router)
+router.include_router(branches_router)
+if init_settings.test:  # pragma: no cover
+    from uedition_editor.api.tests import router as tests_router
+
+    router.include_router(tests_router)
+
+
+class APIStatusAuth(BaseModel):
+    """Pydantic model for validating the auth settings."""
+
+    provider: Literal["no-auth"] | Literal["email"] | Literal["email-password"] | Literal["github"]
+
+
+class APIStatusGit(BaseModel):
+    """Pydantic model for validating the git API status."""
+
+    enabled: bool
+    default_branch: str | None = None
+    protect_default_branch: bool | None = None
+
+
+class APIStatus(BaseModel):
+    """Pydantic model for validating the API status."""
+
+    ready: bool
+    """Indicate whether the API is ready."""
+    git: APIStatusGit
+    """Indicate the Git status."""
+    auth: APIStatusAuth
+    """Indicate the authentication system status."""
+    version: str
+    """The backend API version."""
+
+
+@router.get("", response_model=APIStatus)
+def api() -> dict:
+    """Return the status of the API."""
+    api_status = {
+        "ready": True,
+        "git": {
+            "enabled": False,
+        },
+        "auth": {"provider": init_settings.auth.provider},
+        "version": __version__,
+    }
+    try:
+        Repository(init_settings.base_path, flags=RepositoryOpenFlag.NO_SEARCH)
+        api_status["git"]["enabled"] = True
+        api_status["git"]["default_branch"] = init_settings.git.default_branch
+        api_status["git"]["protect_default_branch"] = init_settings.git.protect_default_branch
+    except GitError:
+        pass
+    return api_status