A Python3 LaTeX over SSH/HTTP service
Project description
# 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
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
xatelite-0.1.2.tar.gz
(3.2 kB
view details)
Built Distribution
File details
Details for the file xatelite-0.1.2.tar.gz
.
File metadata
- Download URL: xatelite-0.1.2.tar.gz
- Upload date:
- Size: 3.2 kB
- Tags: Source
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71979d58827a40314b68d402afba3b11c9f00e3cee22dc15139e4c92955d51c4 |
|
MD5 | fee18cccfb82eff8099716ccab7c3e68 |
|
BLAKE2b-256 | 3c2abe5565203851ee24f0682e4fba06424c7b945741bac89658d18b1edb7268 |
File details
Details for the file xatelite-0.1.2-py3-none-any.whl
.
File metadata
- Download URL: xatelite-0.1.2-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using 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
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 242275c4762d5a66918f7dea095ba522790be2d155876ce32366344772d3acd9 |
|
MD5 | 2d6514435fd5cb7b3ae9ac3d605da8b1 |
|
BLAKE2b-256 | c719c9a342ab83731014f086c0f39aee2a0ee9961d06a9ea52d454b5a48b1bb4 |