Installation¶

Requirements¶

Python 3.8 or higher
Internet connection (for downloading TinyTeX)

Install from PyPI¶

The recommended way to install jettex is via pip:

pip install jettex

Install from Conda¶

jettex is also available on conda-forge:

conda install -c conda-forge jettex

Install from Source¶

For development or to get the latest changes:

git clone git@github.com:gauranshkumar/jettex.git
cd jettex
pip install -e ".[dev]"

Verify Installation¶

After installation, verify that jettex is working:

import jettex
print(jettex.__version__)

Installing TinyTeX¶

After installing the Python package, you need to install TinyTeX itself:

import jettex

# Install the default version (~90 packages, ~100 MB)
jettex.install_tinytex()

# Or install a minimal version (no packages)
jettex.install_tinytex(version=0)

# Or install an extended version (more packages)
jettex.install_tinytex(version=2)

You can also install TinyTeX via the CLI:

jettex install

TinyTeX Versions¶

Version	Description	Size
0	Infraonly - minimal, no LaTeX packages	~1 MB
1	Default - ~90 common packages	~100 MB
2	Extended - more packages for complex documents	~200+ MB

Installation Locations¶

TinyTeX is installed to platform-specific locations:

Platform	Default Location
Windows	`%APPDATA%\TinyTeX`
macOS	`~/Library/TinyTeX`
Linux	`~/.TinyTeX`

You can customize the installation directory:

from pathlib import Path

jettex.install_tinytex(install_dir=Path("/custom/path"))

Environment Variables¶

Variable	Description
`TINYTEX_HOME`	Custom TinyTeX installation directory

Troubleshooting¶

Permission Errors¶

TinyTeX doesn't require administrator privileges. If you encounter permission errors, ensure you have write access to the installation directory.

Network Issues¶

If the download fails, check your internet connection. You can also try:

# Force reinstall
jettex.install_tinytex(force=True)

Checking Installation¶

import jettex

if jettex.is_tinytex_installed():
    print(f"TinyTeX is installed at: {jettex.tinytex_root()}")
    print(f"Version: {jettex.tinytex_version()}")
else:
    print("TinyTeX is not installed")