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

Uploaded Python 3

File details

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

File metadata

  • Download URL: audioarxiv-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 2031512559b7ec37f4be06cea029c693ef12ce21ea5aa30d1d09c0bb6c4397cc
MD5 419f96b0f824d6c7c320e5ed54cd4be2
BLAKE2b-256 a5168a59401f5e0238b0d8b620d4673ffb24a0adca516a75452c78685dd8457e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: audioarxiv-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for audioarxiv-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 946be39a51d0fda5179d54112e198bfeeed0d798277deb44bdb682583b4942e6
MD5 f81d53bf117f4db706cdff4cbfd87052
BLAKE2b-256 4741d07a2b3b39c1128834392bc8a3c397e1852904d5773a13728d1a6562a77d

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