https://github.com/timschneider42/arxify

Package a latex project into an arXiv-compatible archive.
https://github.com/timschneider42/arxify

Last synced: about 2 months ago
JSON representation

Package a latex project into an arXiv-compatible archive.

• Host: GitHub
• URL: https://github.com/timschneider42/arxify
• Owner: TimSchneider42
• License: mit
• Created: 2022-12-07T15:58:32.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T11:07:52.000Z (2 months ago)
• Last Synced: 2024-10-30T12:20:11.946Z (2 months ago)
• Language: Python
• Homepage:
• Size: 11.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arxify - Arxiv Packaging Tool

`arxify` is a command line tool that packages latex projects into an arXiv-compatible archives.

It removes comments from you *.tex files and removes any files that are not needed during the compile process.

The latter is achieved by compiling the project once and observing which files are being accessed by the compiler using `inotify`.

Due to the reliance on `inotify`, this tool is currently available only for Linux.

## Installation

Install `arxify` via 

```bash

pip install arxify

```

## Usage

Call with your latex main file and a target filename for the resulting zip archive:

```bash

arxify /path/to/root/main.tex /path/to/output.zip

```

By default `arxify` will assume that the root directory of your project is the parent directory of your main *.tex file.

Should that not be the case, specify the root directory with the `-r` option:

```bash

arxify /path/to/root/subdir/main.tex /path/to/output.zip -r /path/to/root/

```

By default `arxify` will attempt to compile your project using `pdflatex` and `bibtex`. 

Currently supported are also `lualatex` and `biber`, which can be selected via

```bash

arxify /path/to/root/main.tex /path/to/output.zip -c lualatex -b biber

```

If you wish to include files into the archive that are not used by the compiler, specify them with the `-i` option:

```bash

arxify /path/to/root/main.tex /path/to/output.zip -i /path/to/root/a_file.txt /path/to/root/another_file.txt

```