Skip to main content

A command-line tool and Python library to convert arXiv papers to Markdown format.

Project description

arxiv2md

A command-line tool and Python library for converting arXiv papers to Markdown format.

It retrieves the paper's source code (.tex) from an input arXiv URL and converts it to Markdown format.

Setup

First, you need to install latexml:

# For macOS
brew install latexml

# For Ubuntu
sudo apt update
sudo apt install latexml

Then install arxiv2md:

# Using pip
pip install arxiv2md

# Using uv
uv tool install arxiv2md

Usage

Simply provide the arXiv URL:

arxiv2md https://arxiv.org/abs/1706.03762

For use from Python code:

from arxiv2md import arxiv2md

markdown, metadata = arxiv2md("https://arxiv.org/abs/1706.03762")
with open("output.md", "w") as f:
    f.write(markdown)

Example output file: example.md

Notes

  • The input URL doesn't necessarily need to be the arXiv's abstract page. It will work with PDF pages or source code pages as well. Ultimately, it should work with any string containing an arXiv ID.
  • Papers without provided LaTeX source code cannot be converted.
  • Figures and tables will be ignored.
  • Papers not using bibtex will have reference citations displayed incorrectly.

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

arxiv2md-0.1.2.tar.gz (42.9 kB view details)

Uploaded Source

Built Distribution

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

arxiv2md-0.1.2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file arxiv2md-0.1.2.tar.gz.

File metadata

  • Download URL: arxiv2md-0.1.2.tar.gz
  • Upload date:
  • Size: 42.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for arxiv2md-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6ebd867d482d1f7bfbd65a910aa0c53ff49cad6165361d594ace8c747fc436ba
MD5 94fc105cb5b22f3e651246f43025ba42
BLAKE2b-256 1af090c7405ebef9f82e579c8431a6ab968929ee3368043cabf4de55342544c4

See more details on using hashes here.

File details

Details for the file arxiv2md-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: arxiv2md-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.28 {"installer":{"name":"uv","version":"0.9.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for arxiv2md-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1bc08b962eff55f67a2a4949c9cb1b41530dc21da8bad74d261220ed9eadf17c
MD5 2adc97bc2f0604b983dddf5efb2e4d53
BLAKE2b-256 73ee8f43818ec9ca46cc68f002a2343bfc2c78fe39db3277340ddf5f411cadbf

See more details on using hashes here.

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