Skip to main content
# XaTeLite 🛰️

LaTeX over SSH and HTTP. Lets you remotely compile LaTeX and immediately see
your compiled pdf all remotely.

## Requirements
You need
- Flask
- pdflatex

## Installation
Just install by
```
python3 -m pip install flask
python3 -m pip install xatelite
```

## Usage
The most common use case is ssh-ing into your remote server,
starting xatelite, and opening up a web browser to your xatelite latex server.

Here's an example: after ssh-ing into your server, run
```
$ xatelite -f ~/math/pset4/pset4.tex -q -p 5010
```

This starts an HTTP server on port `5010` and uses `-q` to silence Flask's
output. Now if you visit your server on port `5010` through a web browser,
you'll be presented with your pdf. **Refreshing recompiles the LaTeX file**.

If there's a bug in your .tex file (if pdflatex returns a non-zero error code),
a log file will be presented instead. Use the log file to debug.

## Options
The current options can be accessed by `xatelite -h` and are:

usage: xatelite.py [-h] [-f LATEX_FILE] [-p PORT] [-q] [-qq]

optional arguments:
-h, --help show this help message and exit
-f LATEX_FILE, --latex_file LATEX_FILE
the latex file to be compiled and served. If this is
not passed in, the single *.tex file in the working
directory will be used.
-p PORT, --port PORT specify which port the webserver will run on
-q, --quiet suppress any Flask output
-qq, --qquiet suppress all output including running message

## TODO
- [ ] Better debugging options
- [ ] Maybe have a relaxed mode that allows errors if a pdf is generated?
- [ ] Have a config file with specific pdflatex commands.
- [ ] Recommend `xatelite [file] -qq & disown` for non-screen/tmux users.
- [ ] Have a `-k/--kill` option to kill servers that can take PID/filename
- [ ] Have a `-s/--sessions` option to see PID/filename/ports



Metadata

Release files for xatelite 0.1.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for xatelite 0.1.2
File Size Uploaded Provenance Actions
xatelite-0.1.2.tar.gz 3.2 kB Without provenance Details for xatelite-0.1.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for xatelite 0.1.2
File Interpreter ABI Platform Actions
xatelite-0.1.2-py3-none-any.whl Python 3 none any Details for xatelite-0.1.2-py3-none-any.whl

Total release size: 8.7 kB

Release files / xatelite-0.1.2.tar.gz

Download URL xatelite-0.1.2.tar.gz
Size 3.2 kB
Tags Source
SHA-256 checksum
How to use checksums
71979d58827a40314b68d402afba3b11c9f00e3cee22dc15139e4c92955d51c4
BLAKE2b-256 checksum
How to use checksums
3c2abe5565203851ee24f0682e4fba06424c7b945741bac89658d18b1edb7268
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.7

Release files / xatelite-0.1.2-py3-none-any.whl

Download URL xatelite-0.1.2-py3-none-any.whl
Size 5.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
242275c4762d5a66918f7dea095ba522790be2d155876ce32366344772d3acd9
BLAKE2b-256 checksum
How to use checksums
c719c9a342ab83731014f086c0f39aee2a0ee9961d06a9ea52d454b5a48b1bb4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.6.7

Security for xatelite 0.1.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page