# arxify - Arxiv Packaging Tool
`arxify` is a command line tool that packs 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/TimSchneider42/arxify",
"name": "arxify",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Tim Schneider",
"author_email": "tim@robot-learning.de",
"download_url": "https://files.pythonhosted.org/packages/f4/8b/db0dcba32eb4cfe12c4096b895f8f49233a16975b0096b62d7814fbf29cf/arxify-1.0.2.tar.gz",
"platform": null,
"description": "# arxify - Arxiv Packaging Tool\n`arxify` is a command line tool that packs latex projects into an arxiv compatible archives.\nIt removes comments from you *.tex files and removes any files that are not needed during the compile process.\nThe latter is achieved by compiling the project once and observing which files are being accessed by the compiler using `inotify`.\nDue to the reliance on `inotify`, this tool is currently available only for Linux.\n\n## Installation\nInstall `arxify` via \n```bash\npip install arxify\n```\n\n## Usage\nCall with your latex main file and a target filename for the resulting zip archive:\n```bash\narxify /path/to/root/main.tex /path/to/output.zip\n```\n\nBy default `arxify` will assume that the root directory of your project is the parent directory of your main *.tex file.\nShould that not be the case, specify the root directory with the `-r` option:\n```bash\narxify /path/to/root/subdir/main.tex /path/to/output.zip -r /path/to/root/\n```\n\nBy default `arxify` will attempt to compile your project using `pdflatex` and `bibtex`. \nCurrently supported are also `lualatex` and `biber`, which can be selected via\n```bash\narxify /path/to/root/main.tex /path/to/output.zip -c lualatex -b biber\n```\n\nIf you wish to include files into the archive that are not used by the compiler, specify them with the `-i` option:\n```bash\narxify /path/to/root/main.tex /path/to/output.zip -i /path/to/root/a_file.txt /path/to/root/another_file.txt\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pack a latex project into an arxiv compatible archive.",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/TimSchneider42/arxify"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2e4aeb821658b4e1c2b29e4f9c15392c4f7b1b8716da372f03d2a2795248426b",
"md5": "bc48bdba454156a99b93da2cf508c22b",
"sha256": "0c12942ee319523ae52419895182afd3ce89d4c75e4984118a09944efab2a5d6"
},
"downloads": -1,
"filename": "arxify-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bc48bdba454156a99b93da2cf508c22b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4911,
"upload_time": "2024-05-01T08:21:49",
"upload_time_iso_8601": "2024-05-01T08:21:49.945981Z",
"url": "https://files.pythonhosted.org/packages/2e/4a/eb821658b4e1c2b29e4f9c15392c4f7b1b8716da372f03d2a2795248426b/arxify-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f48bdb0dcba32eb4cfe12c4096b895f8f49233a16975b0096b62d7814fbf29cf",
"md5": "dd27b57c27872ff7a50941f49d9f228a",
"sha256": "e483a2f44e41e801240522d1358661449c685e254b08124b3278d3e2134a108a"
},
"downloads": -1,
"filename": "arxify-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "dd27b57c27872ff7a50941f49d9f228a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4527,
"upload_time": "2024-05-01T08:21:51",
"upload_time_iso_8601": "2024-05-01T08:21:51.106739Z",
"url": "https://files.pythonhosted.org/packages/f4/8b/db0dcba32eb4cfe12c4096b895f8f49233a16975b0096b62d7814fbf29cf/arxify-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 08:21:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "TimSchneider42",
"github_project": "arxify",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "arxify"
}
JSON
