leafpress 0.1.2__tar.gz

leafpress-0.1.2/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.3
+Name: leafpress
+Version: 0.1.2
+Summary: Convert MkDocs sites to PDF, Word, HTML, and ODT documents with branding
+Keywords: mkdocs,pdf,docx,documentation,converter
+Author: Shane Hutchins
+Author-email: Shane Hutchins <hutchins@users.noreply.github.com>
+License: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Dist: typer>=0.12.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: markdown>=3.5
+Requires-Dist: pymdown-extensions>=10.0
+Requires-Dist: pygments>=2.17
+Requires-Dist: weasyprint>=62.0
+Requires-Dist: python-docx>=1.1.0
+Requires-Dist: gitpython>=3.1.40
+Requires-Dist: jinja2>=3.1
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: lxml>=5.0
+Requires-Dist: requests>=2.32
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: odfpy>=1.4.1
+Requires-Dist: pyqt6>=6.6.0 ; extra == 'ui'
+Requires-Dist: pyobjc-framework-cocoa>=10.0 ; sys_platform == 'darwin' and extra == 'ui'
+Maintainer: Shane Hutchins
+Maintainer-email: Shane Hutchins <hutchins@users.noreply.github.com>
+Requires-Python: >=3.13
+Project-URL: Homepage, https://leafpress.dev
+Project-URL: Repository, https://github.com/hutchins/leafpress
+Provides-Extra: ui
+Description-Content-Type: text/markdown
+
+# LeafPress
+
+[![Docs](https://img.shields.io/badge/docs-leafpress.dev-2e7d32)](https://leafpress.dev/)
+[![PyPI](https://img.shields.io/pypi/v/leafpress?color=2e7d32)](https://pypi.org/project/leafpress/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-2e7d32.svg)](https://github.com/hutchins/leafpress/blob/main/LICENSE)
+[![CI](https://github.com/hutchins/leafpress/actions/workflows/ci.yml/badge.svg)](https://github.com/hutchins/leafpress/actions/workflows/ci.yml)
+
+Convert MkDocs sites to PDF, Word, HTML, and ODT documents with branding.
+
+**[Documentation](https://leafpress.dev/)** · **[GitHub](https://github.com/hutchins/leafpress)** · **[PyPI](https://pypi.org/project/leafpress/)**
+
+## Features
+
+- Generate **PDF**, **DOCX**, **HTML**, and **ODT** output from any MkDocs project
+- Cover page, table of contents, and branded footer
+- Logo, colors, and metadata via a simple `leafpress.yml` config
+- Git version info (tag, branch, commit) embedded in output
+- Convert from **local paths** or **remote git URLs**
+- **Desktop UI** — macOS/Linux/Windows menu bar app
+- **CI-friendly** — configure entirely via `LEAFPRESS_*` environment variables
+
+## Installation
+
+```bash
+# uv
+uv add leafpress
+
+# pip
+pip install leafpress
+
+# With desktop UI (PyQt6)
+uv add 'leafpress[ui]'
+pip install 'leafpress[ui]'
+```
+
+WeasyPrint requires system libraries on Linux — see [Installation docs](https://leafpress.dev/installation) for details.
+
+## Quick Start
+
+```bash
+# Generate a starter branding config
+leafpress init
+
+# Convert to PDF
+leafpress convert /path/to/mkdocs/project
+
+# Convert to PDF + DOCX with branding
+leafpress convert /path/to/project -f both -c leafpress.yml
+
+# Convert to HTML or ODT
+leafpress convert /path/to/project -f html
+leafpress convert /path/to/project -f odt
+
+# Convert to all formats (PDF, DOCX, HTML, ODT)
+leafpress convert /path/to/project -f all -c leafpress.yml
+
+# Convert from a remote git repo
+leafpress convert https://github.com/org/repo -b main -f pdf
+
+# Show site info (pages, nav, git status)
+leafpress info /path/to/project
+```
+
+## Desktop UI
+
+```bash
+# Launch menu bar / system tray app
+leafpress ui
+
+# Open the window immediately on launch
+leafpress ui --show
+```
+
+On macOS, LeafPress lives in the menu bar (not the Dock). Click the icon to open the conversion window. Supports all the same options as the CLI, including "Open after conversion".
+
+Requires the `[ui]` extra: `pip install 'leafpress[ui]'`
+
+## CI / GitHub Actions
+
+LeafPress can be configured entirely via environment variables — no `leafpress.yml` needed.
+
+```yaml
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install WeasyPrint system dependencies
+        run: sudo apt-get install -y libpango-1.0-0 libharfbuzz0b libpangoft2-1.0-0
+
+      - name: Install leafpress
+        run: pip install leafpress
+
+      - name: Convert docs to PDF
+        env:
+          LEAFPRESS_COMPANY_NAME: ${{ vars.COMPANY_NAME }}
+          LEAFPRESS_PROJECT_NAME: My Project
+          LEAFPRESS_PRIMARY_COLOR: "#1a73e8"
+        run: leafpress convert . -f pdf -o dist/
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: dist/*.pdf
+```
+
+You can also place a `.env` file in your project root — LeafPress loads it automatically. Shell environment variables always take priority over `.env` values.
+
+See [CI / GitHub Actions docs](https://leafpress.dev/ci) for the full environment variable reference.
+
+## Branding Configuration
+
+Create `leafpress.yml` in your project root (or run `leafpress init`):
+
+```yaml
+company_name: "Acme Corp"
+project_name: "Platform Docs"
+logo_path: "./logo.png"         # local path or https:// URL
+subtitle: "Internal Documentation"
+author: "Engineering Team"
+primary_color: "#1a73e8"        # 6-digit hex
+accent_color: "#ffffff"
+
+footer:
+  include_tag: true
+  include_date: true
+  include_commit: true
+  include_branch: false
+  custom_text: "Confidential"
+
+pdf:
+  page_size: "A4"
+  margin_top: "25mm"
+  margin_bottom: "25mm"
+  margin_left: "20mm"
+  margin_right: "20mm"
+```
+
+## Development
+
+```bash
+uv sync --group dev
+uv run pytest tests/ -v
+uv run ruff check src/
+```

leafpress-0.1.2/README.md

@@ -0,0 +1,147 @@
+# LeafPress
+
+[![Docs](https://img.shields.io/badge/docs-leafpress.dev-2e7d32)](https://leafpress.dev/)
+[![PyPI](https://img.shields.io/pypi/v/leafpress?color=2e7d32)](https://pypi.org/project/leafpress/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-2e7d32.svg)](https://github.com/hutchins/leafpress/blob/main/LICENSE)
+[![CI](https://github.com/hutchins/leafpress/actions/workflows/ci.yml/badge.svg)](https://github.com/hutchins/leafpress/actions/workflows/ci.yml)
+
+Convert MkDocs sites to PDF, Word, HTML, and ODT documents with branding.
+
+**[Documentation](https://leafpress.dev/)** · **[GitHub](https://github.com/hutchins/leafpress)** · **[PyPI](https://pypi.org/project/leafpress/)**
+
+## Features
+
+- Generate **PDF**, **DOCX**, **HTML**, and **ODT** output from any MkDocs project
+- Cover page, table of contents, and branded footer
+- Logo, colors, and metadata via a simple `leafpress.yml` config
+- Git version info (tag, branch, commit) embedded in output
+- Convert from **local paths** or **remote git URLs**
+- **Desktop UI** — macOS/Linux/Windows menu bar app
+- **CI-friendly** — configure entirely via `LEAFPRESS_*` environment variables
+
+## Installation
+
+```bash
+# uv
+uv add leafpress
+
+# pip
+pip install leafpress
+
+# With desktop UI (PyQt6)
+uv add 'leafpress[ui]'
+pip install 'leafpress[ui]'
+```
+
+WeasyPrint requires system libraries on Linux — see [Installation docs](https://leafpress.dev/installation) for details.
+
+## Quick Start
+
+```bash
+# Generate a starter branding config
+leafpress init
+
+# Convert to PDF
+leafpress convert /path/to/mkdocs/project
+
+# Convert to PDF + DOCX with branding
+leafpress convert /path/to/project -f both -c leafpress.yml
+
+# Convert to HTML or ODT
+leafpress convert /path/to/project -f html
+leafpress convert /path/to/project -f odt
+
+# Convert to all formats (PDF, DOCX, HTML, ODT)
+leafpress convert /path/to/project -f all -c leafpress.yml
+
+# Convert from a remote git repo
+leafpress convert https://github.com/org/repo -b main -f pdf
+
+# Show site info (pages, nav, git status)
+leafpress info /path/to/project
+```
+
+## Desktop UI
+
+```bash
+# Launch menu bar / system tray app
+leafpress ui
+
+# Open the window immediately on launch
+leafpress ui --show
+```
+
+On macOS, LeafPress lives in the menu bar (not the Dock). Click the icon to open the conversion window. Supports all the same options as the CLI, including "Open after conversion".
+
+Requires the `[ui]` extra: `pip install 'leafpress[ui]'`
+
+## CI / GitHub Actions
+
+LeafPress can be configured entirely via environment variables — no `leafpress.yml` needed.
+
+```yaml
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install WeasyPrint system dependencies
+        run: sudo apt-get install -y libpango-1.0-0 libharfbuzz0b libpangoft2-1.0-0
+
+      - name: Install leafpress
+        run: pip install leafpress
+
+      - name: Convert docs to PDF
+        env:
+          LEAFPRESS_COMPANY_NAME: ${{ vars.COMPANY_NAME }}
+          LEAFPRESS_PROJECT_NAME: My Project
+          LEAFPRESS_PRIMARY_COLOR: "#1a73e8"
+        run: leafpress convert . -f pdf -o dist/
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: dist/*.pdf
+```
+
+You can also place a `.env` file in your project root — LeafPress loads it automatically. Shell environment variables always take priority over `.env` values.
+
+See [CI / GitHub Actions docs](https://leafpress.dev/ci) for the full environment variable reference.
+
+## Branding Configuration
+
+Create `leafpress.yml` in your project root (or run `leafpress init`):
+
+```yaml
+company_name: "Acme Corp"
+project_name: "Platform Docs"
+logo_path: "./logo.png"         # local path or https:// URL
+subtitle: "Internal Documentation"
+author: "Engineering Team"
+primary_color: "#1a73e8"        # 6-digit hex
+accent_color: "#ffffff"
+
+footer:
+  include_tag: true
+  include_date: true
+  include_commit: true
+  include_branch: false
+  custom_text: "Confidential"
+
+pdf:
+  page_size: "A4"
+  margin_top: "25mm"
+  margin_bottom: "25mm"
+  margin_left: "20mm"
+  margin_right: "20mm"
+```
+
+## Development
+
+```bash
+uv sync --group dev
+uv run pytest tests/ -v
+uv run ruff check src/
+```

leafpress-0.1.2/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["uv_build>=0.10.9,<0.11"]
+build-backend = "uv_build"
+
+[project]
+name = "leafpress"
+version = "0.1.2"
+description = "Convert MkDocs sites to PDF, Word, HTML, and ODT documents with branding"
+readme = "README.md"
+authors = [{name = "Shane Hutchins", email = "hutchins@users.noreply.github.com"}]
+maintainers = [
+  {name = "Shane Hutchins", email = "hutchins@users.noreply.github.com"}
+]
+requires-python = ">=3.13"
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Documentation",
+    "Topic :: Text Processing :: Markup :: Markdown",
+]
+keywords = ["mkdocs", "pdf", "docx", "documentation", "converter"]
+
+dependencies = [
+    "typer>=0.12.0",
+    "rich>=13.0.0",
+    "pyyaml>=6.0",
+    "pydantic>=2.0",
+    "markdown>=3.5",
+    "pymdown-extensions>=10.0",
+    "pygments>=2.17",
+    "weasyprint>=62.0",
+    "python-docx>=1.1.0",
+    "gitpython>=3.1.40",
+    "jinja2>=3.1",
+    "beautifulsoup4>=4.12",
+    "lxml>=5.0",
+    "requests>=2.32",
+    "python-dotenv>=1.0",
+    "odfpy>=1.4.1",
+]
+
+[project.optional-dependencies]
+ui = [
+    "pyqt6>=6.6.0",
+    "pyobjc-framework-cocoa>=10.0; sys_platform == 'darwin'",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov>=5.0",
+    "ruff>=0.5.0",
+    "mypy>=1.10",
+]
+
+[project.scripts]
+leafpress = "leafpress.cli:cli"
+
+[project.urls]
+Homepage = "https://leafpress.dev"
+Repository = "https://github.com/hutchins/leafpress"
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+module-root = "src"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "N", "W", "UP", "B", "SIM", "RUF"]
+
+[tool.ruff.lint.per-file-ignores]
+"src/leafpress/cli.py" = ["B008"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-v --tb=short"
+markers = ["docker: tests requiring Docker (may be slow)"]
+
+[tool.coverage.run]
+source = ["leafpress"]
+omit = ["src/leafpress/ui/*"]
+
+[tool.coverage.report]
+show_missing = true
+skip_empty = true
+fail_under = 70
+
+[tool.mypy]
+python_version = "3.10"
+strict = true

leafpress-0.1.2/src/leafpress/__init__.py

@@ -0,0 +1,10 @@
+"""leafpress - Convert MkDocs sites to PDF, Word, HTML, and ODT documents."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("leafpress")
+except PackageNotFoundError:
+    __version__ = "0.0.0"
+
+from leafpress.pipeline import convert  # noqa: F401

leafpress-0.1.2/src/leafpress/__main__.py

@@ -0,0 +1,5 @@
+"""Allow running as `python -m leafpress`."""
+
+from leafpress.cli import cli
+
+cli()