pretty-notebook 0.10.0rc2__py3-none-any.whl

pnbp/__init__.py

@@ -0,0 +1,2 @@
+"""Compatibility exports; prefer pretty_notebook."""
+from pretty_notebook import *  # noqa: F403

pnbp/_icons.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.icons."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.icons")

pnbp/_identities.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.identities."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.identities")

pnbp/_journal.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.journal."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.journal")

pnbp/_links.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.links."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.links")

pnbp/_moves.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.moves."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.moves")

pnbp/_navigation.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.navigation."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.navigation")

pnbp/_publication_execute.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.publication_execute."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.publication_execute")

pnbp/_publication_plan.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.publication_plan."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.publication_plan")

pnbp/_publication_state.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.publication_state."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.publication_state")

pnbp/_publishing.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.publishing."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.publishing")

pnbp/_rendering.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.rendering."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.rendering")

pnbp/_routes.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.routes."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.routes")

pnbp/_search.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.search."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.search")

pnbp/_storage.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook._internal.storage."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook._internal.storage")

pnbp/cli.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.cli."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.cli")

pnbp/commands/__init__.py

@@ -0,0 +1,2 @@
+"""Compatibility exports; prefer pretty_notebook.commands."""
+from pretty_notebook.commands import *  # noqa: F403

pnbp/commands/code.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.code."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.code")

pnbp/commands/collect.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.collect."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.collect")

pnbp/commands/commit.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.commit."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.commit")

pnbp/commands/correct.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.correct."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.correct")

pnbp/commands/deploy.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.deploy."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module('pretty_notebook.commands.deploy')

pnbp/commands/graph.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.graph."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.graph")

pnbp/commands/pprint.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.pprint."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.pprint")

pnbp/commands/subl.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.subl."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.subl")

pnbp/commands/tasks.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.commands.tasks."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.commands.tasks")

pnbp/helpers/__init__.py

@@ -0,0 +1,2 @@
+"""Compatibility exports; prefer pretty_notebook.helpers."""
+from pretty_notebook.helpers import *  # noqa: F403

pnbp/helpers/_datetime.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.helpers._datetime."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.helpers._datetime")

pnbp/helpers/wrappers.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.helpers.wrappers."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.helpers.wrappers")

pnbp/models/__init__.py

@@ -0,0 +1,2 @@
+"""Compatibility exports; prefer pretty_notebook.models."""
+from pretty_notebook.models import *  # noqa: F403

pnbp/models/components/__init__.py

@@ -0,0 +1,2 @@
+"""Compatibility exports; prefer pretty_notebook.models.components."""
+from pretty_notebook.models.components import *  # noqa: F403

pnbp/models/components/codeblock.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.components.codeblock."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.components.codeblock")

pnbp/models/components/component.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.components.component."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.components.component")

pnbp/models/components/link.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.components.link."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.components.link")

pnbp/models/components/tag.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.components.tag."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.components.tag")

pnbp/models/components/url.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.components.url."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.components.url")

pnbp/models/note.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.note."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.note")

pnbp/models/notebook.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.models.notebook."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.models.notebook")

pnbp/settings.py

@@ -0,0 +1,5 @@
+"""Compatibility alias; prefer pretty_notebook.settings."""
+from importlib import import_module
+import sys
+
+sys.modules[__name__] = import_module("pretty_notebook.settings")

pretty_notebook/__init__.py

@@ -0,0 +1,7 @@
+from .models import Notebook, Note
+from .settings import NotebookSettings, SettingsError
+from pretty_notebook._internal.identities import IdentityError
+from pretty_notebook._internal.search import SearchHit
+from pretty_notebook._internal.navigation import NavigationHistory, NavigationIndex
+
+__all__ = ["Notebook", "Note", "NotebookSettings", "SettingsError", "IdentityError", "SearchHit", "NavigationIndex", "NavigationHistory"]

pretty_notebook/_internal/__init__.py

@@ -0,0 +1 @@
+"""Private implementation helpers; use the public package API."""

pretty_notebook/_internal/deployment.py

@@ -0,0 +1,184 @@
+"""Reproducible Linux VPS bundles and bounded local deployment diagnostics."""
+
+import hashlib
+import json
+import re
+import shlex
+import subprocess
+from dataclasses import asdict, dataclass
+from importlib.resources import files
+from pathlib import Path
+from urllib.request import Request, urlopen
+
+from .routes import validate_prefix
+
+
+@dataclass(frozen=True)
+class DeploySpec:
+    revision: str
+    domain: str
+    checkout: Path = Path('/opt/pretty-notebook')
+    data_dir: Path = Path('/var/lib/pretty-notebook')
+    env_file: Path = Path('/etc/pretty-notebook/environment')
+    backup_dir: Path = Path('/var/backups/pretty-notebook')
+    tls_cert: Path = Path('/etc/ssl/pretty-notebook/fullchain.pem')
+    tls_key: Path = Path('/etc/ssl/pretty-notebook/privkey.pem')
+    service: str = 'pretty-notebook'
+    user: str = 'pretty-notebook'
+    python: str = 'python3.14'
+    port: int = 8000
+    workers: int = 4
+    prefix: str = ''
+
+    def __post_init__(self):
+        if not re.fullmatch(r'(?:[0-9a-f]{40}|[0-9a-f]{64})', self.revision):
+            raise ValueError('Revision must be a full lowercase commit SHA.')
+        labels = self.domain.split('.')
+        if len(self.domain) > 253 or len(labels) < 2 or any(not re.fullmatch(r'[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?', label) for label in labels):
+            raise ValueError('Domain must be a lowercase DNS hostname without a scheme or port.')
+        for name in ('service', 'user'):
+            if not re.fullmatch(r'[a-z_][a-z0-9_-]{0,31}', getattr(self, name)):
+                raise ValueError(f'Invalid deployment {name}.')
+        if self.user == 'root':
+            raise ValueError('Use a dedicated non-root service account.')
+        for name in ('checkout', 'data_dir', 'env_file', 'backup_dir', 'tls_cert', 'tls_key'):
+            value = Path(getattr(self, name))
+            if not value.is_absolute() or len(value.parts) < 3 or '..' in value.parts or not re.fullmatch(r'/[A-Za-z0-9/_.-]+', str(value)):
+                raise ValueError(f'{name} must be an absolute path without shell/systemd metacharacters.')
+            object.__setattr__(self, name, value)
+        directories = (self.checkout, self.data_dir, self.backup_dir)
+        if any(a.is_relative_to(b) or b.is_relative_to(a) for i, a in enumerate(directories) for b in directories[i + 1:]):
+            raise ValueError('Checkout, data and backup directories must be separate.')
+        if any(self.env_file.is_relative_to(path) for path in directories):
+            raise ValueError('Environment file must be separate from code, data and backups.')
+        if self.python not in ('python3.11', 'python3.14'):
+            raise ValueError('Use supported Python 3.11 or 3.14.')
+        if type(self.port) is not int or not 1024 <= self.port <= 65535:
+            raise ValueError('Port must be from 1024 to 65535.')
+        if type(self.workers) is not int or not 1 <= self.workers <= 4:
+            raise ValueError('Workers must be from 1 to 4.')
+        validate_prefix(self.prefix)
+
+    def to_dict(self):
+        return {key: str(value) if isinstance(value, Path) else value for key, value in asdict(self).items()}
+
+
+def bundle(spec, operation='init'):
+    if operation not in ('init', 'upgrade'):
+        raise ValueError('Unknown deployment operation.')
+    values = {key.upper(): str(value) for key, value in spec.to_dict().items()}
+    values.update({key + '_SH': shlex.quote(value) for key, value in list(values.items())})
+    values['PROXY'] = f'''        proxy_pass http://127.0.0.1:{spec.port};
+        proxy_http_version 1.1;
+        proxy_set_header Host $host;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header X-Forwarded-For $remote_addr;
+        proxy_connect_timeout 5s;
+        proxy_read_timeout 35s;
+        proxy_send_timeout 35s;'''
+    values['PREFIX_REDIRECT'] = f'    location = {spec.prefix} {{ return 308 {spec.prefix}/; }}' if spec.prefix else ''
+    resources = files('pretty_notebook').joinpath('resources/deploy')
+    result = {}
+    for name in ('service', 'nginx.conf', 'environment.example', 'common.sh', 'init.sh', 'upgrade.sh', 'rollback.sh', 'checkpoint.py'):
+        template = resources.joinpath(name + '.tmpl').read_text(encoding='utf-8')
+        rendered = re.sub(r'@([A-Z_]+)@', lambda match: values[match[1]], template)
+        result[spec.service + '.service' if name == 'service' else name] = rendered
+    manifest = {'format': 1, 'operation': operation, 'spec': spec.to_dict(),
+                'files': {name: hashlib.sha256(content.encode()).hexdigest() for name, content in result.items()},
+                'apply': f'sudo bash {operation}.sh',
+                'requirements': ['Linux x86_64, systemd, nginx, git, curl and the selected Python',
+                                 'An existing TLS certificate/key and a private configured environment file']}
+    result['plan.json'] = json.dumps(manifest, indent=2, sort_keys=True) + '\n'
+    return result
+
+
+def write_bundle(spec, output, *, operation='init'):
+    output = Path(output).expanduser()
+    if output.is_symlink():
+        raise ValueError('Bundle directory must not be a symlink.')
+    output = output.resolve()
+    contents = bundle(spec, operation)
+    for name, content in contents.items():
+        path = output / name
+        if path.is_symlink() or (path.exists() and (not path.is_file() or path.read_text() != content)):
+            raise ValueError(f'{name} already differs; choose an empty output directory.')
+    output.mkdir(parents=True, mode=0o700, exist_ok=True)
+    for name, content in contents.items():
+        path = output / name
+        if not path.exists():
+            with path.open('x', encoding='utf-8') as target:
+                target.write(content)
+            path.chmod(0o700 if name.endswith('.sh') else 0o600)
+    return {'output': str(output), 'operation': operation, 'revision': spec.revision,
+            'apply': f'sudo bash {shlex.quote(str(output / (operation + ".sh")))}'}
+
+
+def _run_checked(arguments, *, cwd=None, label):
+    try:
+        result = subprocess.run(arguments, cwd=cwd, capture_output=True, text=True, timeout=30)
+    except (OSError, subprocess.TimeoutExpired) as error:
+        raise ValueError(f'{label} could not run.') from error
+    if result.returncode:
+        raise ValueError(f'{label} failed; inspect it locally without sharing credentials.')
+    return result.stdout.strip()
+
+
+def check_environment(spec, *, require_bootstrap=False):
+    path = spec.env_file
+    if path.is_symlink() or not path.is_file() or path.stat().st_mode & 0o077:
+        raise ValueError('Environment file must be a private regular file (mode 0600).')
+    values = {}
+    for line in path.read_text(encoding='utf-8').splitlines():
+        line = line.strip()
+        if not line or line.startswith('#'): continue
+        match = re.fullmatch(r'([A-Z_][A-Z0-9_]*)=(.*)', line)
+        if not match or match[1] in values:
+            raise ValueError('Environment file contains an invalid or duplicate assignment.')
+        try: parsed = shlex.split(match[2])
+        except ValueError as error: raise ValueError('Environment file contains invalid quoting.') from error
+        if len(parsed) > 1:
+            raise ValueError('Environment values containing spaces must be quoted.')
+        values[match[1]] = parsed[0] if parsed else ''
+    for key, expected in {'PNBP_DATA_DIR': str(spec.data_dir),
+                          'PNBP_DATABASE_URL': f'sqlite://{spec.data_dir / "db.sqlite3"}',
+                          'PNBP_URL_PREFIX': spec.prefix, 'PNBP_ASSET_MODE': 'local', 'JWT_ALGO': 'HS256'}.items():
+        if values.get(key, '') != expected: raise ValueError(f'Environment {key} does not match the deployment plan.')
+    hosts = values.get('PNBP_ALLOWED_HOSTS', '').split(',')
+    if spec.domain not in hosts or '*' in hosts:
+        raise ValueError('Environment PNBP_ALLOWED_HOSTS must include the planned domain without a wildcard.')
+    for key in ('JWT_SECRET', 'PNBP_BOOTSTRAP_TOKEN'):
+        value = values.get(key, '')
+        required = key == 'JWT_SECRET' or require_bootstrap or bool(value)
+        if required and (len(value.encode()) < 32 or value.startswith('REPLACE_')):
+            raise ValueError(f'Environment {key} requires a configured secret of at least 32 UTF-8 bytes.')
+    return {'environment': 'ok'}
+
+
+def check_deployment(spec, *, health=False, require_bootstrap=False):
+    result = check_environment(spec, require_bootstrap=require_bootstrap)
+    import pwd
+    try:
+        owner = pwd.getpwnam(spec.user).pw_uid
+    except KeyError as error:
+        raise ValueError('The planned service account does not exist.') from error
+    state = spec.data_dir
+    if owner == 0 or state.is_symlink() or not state.is_dir() or state.stat().st_mode & 0o077 or state.stat().st_uid != owner:
+        raise ValueError('Persistent data must be a private directory owned by the non-root service account.')
+    revision = _run_checked(['git', '-C', str(spec.checkout), 'rev-parse', 'HEAD'], label='Checkout revision check')
+    if revision != spec.revision: raise ValueError('Checkout does not match the pinned revision.')
+    _run_checked(['git', '-C', str(spec.checkout), 'diff', '--exit-code'], label='Checkout cleanliness check')
+    python = str(spec.checkout / '.venv/bin/python')
+    version = _run_checked([python, '-c', 'import sys; print("%s.%s" % sys.version_info[:2])'], label='Python version check')
+    if version != spec.python.removeprefix('python'): raise ValueError('Virtual environment uses a different Python version.')
+    _run_checked([python, '-m', 'pip', 'check'], label='Dependency check')
+    _run_checked([python, 'install_assets.py', '--check'], cwd=spec.checkout / 'apps/web', label='Local asset check')
+    result.update(revision=revision, dependencies='ok', assets='ok', python=version)
+    if health:
+        try:
+            request = Request(f'http://127.0.0.1:{spec.port}/healthz', headers={'Host': spec.domain})
+            with urlopen(request, timeout=5) as response:
+                if json.loads(response.read(4096)) != {'status': 'ok'}: raise ValueError('Invalid health response.')
+        except (OSError, ValueError) as error:
+            raise ValueError('Loopback health check failed.') from error
+        result['health'] = 'ok'
+    return result

pretty_notebook/_internal/icons.py

@@ -0,0 +1,51 @@
+"""Small project-owned SVGs for templates and generated notebook links."""
+
+import re
+from html import escape
+
+_SHAPES = {
+    "menu": '<path d="M3 6h18M3 12h18M3 18h18"/>',
+    "sun": '<circle cx="12" cy="12" r="4"/><path d="M12 2v2m0 16v2M2 12h2m16 0h2M5 5l1.5 1.5m11 11L19 19M5 19l1.5-1.5m11-11L19 5"/>',
+    "moon": '<path d="M20 14.5A8.5 8.5 0 0 1 9.5 4 8.5 8.5 0 1 0 20 14.5Z"/>',
+    "book": '<path d="M12 5v15m0-15C9 3 5 3 2 4v15c3-1 7-1 10 1 3-2 7-2 10-1V4c-3-1-7-1-10 1Z"/>',
+    "globe": '<circle cx="12" cy="12" r="9"/><ellipse cx="12" cy="12" rx="4" ry="9"/><path d="M3 12h18"/>',
+    "external": '<path d="M14 3h7v7m0-7L11 13M10 5H4a1 1 0 0 0-1 1v14a1 1 0 0 0 1 1h14a1 1 0 0 0 1-1v-6"/>',
+}
+_SIZES = {"sm": 14, "md": 20, "lg": 24}
+_LEGACY = {"eye": "moon", "eye-fill": "sun", "book-fill": "book",
+           "globe2": "globe", "box-arrow-up-right": "external"}
+_LEGACY_MARKUP = re.compile(
+    r"<(?P<literal>pre|code|script|style)\b[^>]*>.*?</(?P=literal)\s*>"
+    r"|<i\s+class=(?P<quote>['\"])bi bi-(?P<name>[\w-]+)(?P=quote)"
+    r"(?:\s+style=['\"]font-size:10px;['\"])?\s*>\s*</i\s*>",
+    re.IGNORECASE | re.DOTALL,
+)
+
+
+def render_icon(name, *, label=None, size="md", variant="default"):
+    """Return an inline SVG; adjacent text normally supplies its accessible name."""
+    if name not in _SHAPES or size not in _SIZES or variant not in {"default", "muted"}:
+        raise ValueError("Choose a supported icon, size (sm/md/lg), and variant (default/muted).")
+    accessibility = ('aria-hidden="true"' if label is None else
+                     f'role="img" aria-label="{escape(label, quote=True)}"')
+    return (
+        f'<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-{size} icon-{variant}" '
+        f'width="{_SIZES[size]}" height="{_SIZES[size]}" viewBox="0 0 24 24" '
+        f'{accessibility} focusable="false" fill="none" stroke="currentColor" '
+        f'stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round">'
+        f'{_SHAPES[name]}</svg>'
+    )
+
+
+def replace_legacy_icons(markup):
+    """Display the five historical empty icon elements without rewriting storage.
+
+    Leave literal code, script/style blocks, unknown icons, and other HTML intact.
+    """
+    def replace(match):
+        name = _LEGACY.get((match.group("name") or "").lower())
+        if name is None:
+            return match.group(0)
+        label = {"book": "Notebook", "globe": "Published notebook"}.get(name)
+        return render_icon(name, label=label, size="sm" if name == "external" else "md")
+    return _LEGACY_MARKUP.sub(replace, markup)