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.2rc66.post1.tar.gz (41.3 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.2rc66.post1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for audioarxiv-0.1.2rc66.post1.tar.gz
Algorithm Hash digest
SHA256 fdd926c20d902bcdf1c0a7ababe23a7b1f5cc48fe9e47ecf7ba8a86220043227
MD5 8b3960320231ba50e09483b32a738c2b
BLAKE2b-256 5d1756fb7484392f58893bd0c0d5bcfe9c1aeb3a1b25480fb5f061d597b3ffc0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc66.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 e12646ed93d0d657259e0ea6adea9f2e587a75545052d2e929f4dd8b112dad1a
MD5 84df0b206872bb15d0e7a2fcf625eec7
BLAKE2b-256 b5cde98d8a39813c3c53a14858d766a7dd4e04a69146fdad0d7e6fcf98652ccd

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