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.0.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.0-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: overleaf2arxiv-0.2.0.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.0.tar.gz
Algorithm Hash digest
SHA256 03e1beba346450d7b67d46086ffad1b166ae35af801f52bcdaad0b6f1b7db703
MD5 47483ea66cd77096c6ff18a82b9adf77
BLAKE2b-256 848642a431e6a63d40a45ec9e51ae4da08043ec1d7ec7496706d7cb3b9beac89

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf2arxiv-0.2.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: overleaf2arxiv-0.2.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6818c8b7648efafcd50abd682b74a13b49de291c6f99bc0f371aaf5410833329
MD5 cefc0141052b31ecfc9aa84b37caedd3
BLAKE2b-256 fb41fd38a617799b8b99ef662218d57ed2cf7b2151c4bd16572edc8fe9a84a2a

See more details on using hashes here.

Provenance

The following attestation bundles were made for overleaf2arxiv-0.2.0-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