Installation¶
vexy-dexypy is a Python package with a command-line tool. The core install
gives you the playwright, reveal and impress strategies. Other strategies
need extra programs on your PATH.
Requirements¶
- Python 3.12 or newer.
- A Chromium build for Playwright. The default
livefetch mode, the pagination probe and the browser-driven exporters all use it.
Install the package¶
-
Install the package with
uv:Or run it without installing:
-
Install the Chromium browser that Playwright drives:
-
Check which strategies are available on your machine:
The help text ends with a line such as
Available strategies: impress, playwright, reveal.and, if some are missing,Unavailable (install deps): ….
Optional extras¶
The package defines these extras in pyproject.toml:
| Extra | Installs | Used for |
|---|---|---|
extract |
trafilatura |
Article-body extraction in the generic importer's Python fallback |
pdf |
pikepdf |
PDF post-processing |
vision |
instructor |
Vision-model tooling |
all |
playwright, trafilatura, pikepdf |
Everything above except vision |
Install an extra with:
Optional external programs¶
Each of these enables one strategy or feature. A strategy whose program is
missing is skipped when you ask for all strategies.
| Program | Enables | How vexy-dexypy finds it |
|---|---|---|
vivliostyle (Vivliostyle CLI) |
vivliostyle strategy |
vivliostyle on PATH |
prince (PrinceXML) |
prince strategy |
VEXY_DEX_PRINCE_PATH environment variable, then prince on PATH |
marp (Marp CLI) or npx |
marp strategy |
marp on PATH; otherwise npx -y @marp-team/marp-cli |
single-file or monolith |
--fetch_mode offline |
the configured tool on PATH |
vexy-pdfsvgpy (Python) |
--svg output |
importable as vexy_pdfsvgpy |
Ollama or another server with an /api/chat endpoint |
--vision |
[vision] endpoint, default http://localhost:11434 |
To install the Vivliostyle CLI with npm:
Install from source¶
-
Clone the repository:
-
Create the environment with all extras:
-
Run the tool from the checkout:
The version number comes from the latest git tag (through hatch-vcs), so a
checkout without tags reports a development version.