Metadata-Version: 2.4
Name: overleaf2arxiv
Version: 0.2.0
Summary: A tool to convert Overleaf projects to arXiv-compatible formats
Home-page: https://github.com/abhayd/Overleaf2Arxiv
Author: Abhay Deshpande
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyoverleaf
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Overleaf2Arxiv

Academics often write papers in [Overleaf](https://www.overleaf.com), and publish them to [arXiv](https://arxiv.org), but the steps to do so requires a little manual labor.
For example, arXiv requires a `main.bbl` file, which must be manually downloaded from Overleaf and packaged into the zip file.

Overleaf2Arxiv is a simple CLI that aims to make this easier.
Given the Overleaf project ID, it will automatically package it for upload to arXiv, including the `main.bbl` file.

> [!NOTE]
> MacOS and Linux are the primary supported platforms.

## Installation + Setup

To install, run

```bash
pip install overleaf2arxiv
```

Additionally, ensure that you are logged into [Overleaf](https://www.overleaf.com) on your default browser.
The cookies on this browser will be used to authenticate with Overleaf, possibly asking for your keychain password in the process.

Finally, install `pdflatex` on your machine and ensure it's available on the system path.
- On Linux, consider [TeX Live](https://www.tug.org/texlive/)
- On Mac, consider one of:
    - [TeX Live](https://www.tug.org/texlive/)
    - BasicTeX (smaller installation), install with `brew install basictex`

## Usage

Using this script is easy!

To automatically download the project from Overleaf and package it, simply run

```bash
overleaf2arxiv -p <project_id> project.zip
```

where `<project_id>` is the Overleaf project ID (visible in the URL). This may ask for a password while authenticating with Overleaf to download your project.

You can avoid authenticating with Overleaf by downloading the project zip manually, and then running:

```bash
overleaf2arxiv -f <path_to_downloaded_project.zip> project.zip
```

Finally, just upload `project.zip` to arXiv!
