Skip to main content

Tar all files needed to re-compile your LaTeX project

Project description

tartex

PyPI - Version PyPI - Python Version Hatch project


TarTeX is a command-line utility to generate a tarball including all (non-system) source files needed to compile your LaTeX project.

Table of Contents

Installation

Note: You must have latexmk and pdflatex, as well as a full LaTeX env installed. tartex will not include any system-wide files, such as TeX style files, classes, etc. in the tar file.

Using pipx

This is the easy way to install tagged releases.

pipx install tartex

From GitHub sources:

Compile using hatch to generate a wheel, which may be then installed using pipx as follows:

git clone https://github.com/badshah400/tartex.git
cd tartex
hatch build
pipx install ./dist/*.whl

Usage

Supported OS: Potentially any POSIX-like, tested only on Linux.

usage: tartex [-h] [-a ADD] [-b] [-l] [-o OUTPUT] [-s] [-v] [-x EXCL] fname

Build a tarball including all source files needed to compile your LaTeX project (version 0.1.0a1).

positional arguments:
  fname                 Input file name (.tex or .fls) (mandatory)

options:
  -h, --help            show this help message and exit
  -a ADD, --add ADD     Comma separated list of additional files (wildcards allowed!) to include (loc relative to main TeX file)
  -b, --bib             find and add bib file to tarball
  -l, --list            Print a list of files to include and quit (no tarball generated)
  -o OUTPUT, --output OUTPUT
                        Name of output tar.gz file (w/o the .tar.gz extension)
  -s, --summary         Print a summary at the end
  -v, --verbose         Display file names added to tarball
  -x EXCL, --excl EXCL  Comma separated list of files (wildcards allowed!) to exclude (loc relative to main TeX file)

License

tartex is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tartex-0.1.0a2.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

tartex-0.1.0a2-py3-none-any.whl (7.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page