Skip to main content

A tool to convert Overleaf projects to arXiv-compatible formats

Project description

Overleaf2Arxiv

Academics often write papers in Overleaf, and publish them to arXiv, 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

pip install overleaf2arxiv

Additionally, ensure that you are logged into Overleaf 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
  • On Mac, consider one of:
    • TeX Live
    • 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

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:

overleaf2arxiv -f <path_to_downloaded_project.zip> project.zip

Finally, just upload project.zip to arXiv!

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

overleaf2arxiv-0.2.1.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

overleaf2arxiv-0.2.1-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file overleaf2arxiv-0.2.1.tar.gz.

File metadata

  • Download URL: overleaf2arxiv-0.2.1.tar.gz
  • Upload date:
  • Size: 3.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for overleaf2arxiv-0.2.1.tar.gz
Algorithm Hash digest
SHA256 78d15e3121716a1498f400f203fa8c58a2501179f8f23eb3f5f7bceb1da4e137
MD5 a1a1c66c25a38ae0adb27fdd3315ed57
BLAKE2b-256 370b82b16fe29476a888e2773d4047ec69b0fd6dbcb03011d25b298e2c3252ae

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf2arxiv-0.2.1.tar.gz:

Publisher: publish.yaml on abhaybd/Overleaf2Arxiv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file overleaf2arxiv-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: overleaf2arxiv-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for overleaf2arxiv-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8130c85b7c440b1fe2059400dcaee4a94e555b8f5e5fc1e4e3decd7d2fd44033
MD5 486413526535c362fcbb76beffbb4b8a
BLAKE2b-256 7006ca1099dadcf134af1dc531a76e6c3ac0815282805f57a72cb2e51a049c44

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf2arxiv-0.2.1-py3-none-any.whl:

Publisher: publish.yaml on abhaybd/Overleaf2Arxiv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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