Skip to main content

Turn arXiv papers into audio. audioarxiv lets you fetch the research papers from arXiv and read them aloud.

Project description

🎧 audioarxiv

PyPI version License: MIT Build codecov Python Version Security: bandit Documentation Status DOI

📚 Documentation: https://isaac-cf-wong.github.io/audioarxiv/

Turn arXiv papers into audio. audioarxiv lets you fetch the research papers from arXiv and read them aloud.


🚀 Features

  • 🔍 Search and retrieve papers using the arXiv API
  • 📄 Extract and parse the content from PDF (excluding title/abstract)
  • 🗣️ Convert text to speech with natural voice output
  • 🧠 Great for passive learning while commuting or doing chores

📦 Installation

Install from PyPI:

pip install audioarxiv

Install from Conda:

conda install -c conda-forge audioarxiv

🛠 Usage

audioarxiv --id "<arxiv id>"

🎙️ Text-to-Speech Options

You can customize the voice engine using pyttsx3 by specifying the speaking rate, volume, voice, and pause between sentences.

audioarxiv --id "<arxiv id>" --rate <rate> --volume <volume> --voice "<voice>" --pause-seconds <pause-seconds>
  • rate: Number of words per minutes. Defaults to 140.
  • volume: Volume of the audio. Defaults to 0.9.
  • voice: Voice of the audio. Defaults to the pyttsx3 default voice.
  • pause-seconds: Number of seconds to pause between sentences.

The settings are saved, so you only need to provide your preferred settings once.

Contributing

Contributions and suggestions are welcome! Whether it's fixing bugs, improving documentation, or adding new features, your help is appreciated.

Please read our Code of Conduct before contributing.

To get started:

  • Fork the repository
  • Create a new branch for your changes
  • Submit a pull request

If you're unsure where to begin, feel free to open an issue or ask for guidance!

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

audioarxiv-0.1.2rc62.post1.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

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

audioarxiv-0.1.2rc62.post1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file audioarxiv-0.1.2rc62.post1.tar.gz.

File metadata

  • Download URL: audioarxiv-0.1.2rc62.post1.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for audioarxiv-0.1.2rc62.post1.tar.gz
Algorithm Hash digest
SHA256 71cc56689aef9fccc56ff22280a658d0a5571dc9501c74297f5dee2ec903a9b2
MD5 f88d54f5b4b7f6794e53d81c7bf187de
BLAKE2b-256 d85fad0fb05483990d499e4ca21ab2597c0f4389dcf3e65e9c671c500432b58a

See more details on using hashes here.

File details

Details for the file audioarxiv-0.1.2rc62.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc62.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 6be84dd0e93e74669851a7bafd773fddf5fb1588ff8e171c4eb04a665433d8af
MD5 3ae61959cecaa96787b6a519ada486a3
BLAKE2b-256 7da3e71ba1cffc3d23319325d1a1e02f4c7671ac315330b706427a8860f945a8

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