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

🛠 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.2rc81.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.2rc81.post1-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for audioarxiv-0.1.2rc81.post1.tar.gz
Algorithm Hash digest
SHA256 8c54bcaa89a7e10e4d42d8a4876265b173f21099402c0bf6c700fd41bc1176fa
MD5 c59124013be28512255a6bd8905c0e18
BLAKE2b-256 280c8f463f4a96c66d491a73b26c5facbfd2aaf80a18f84af7a30314f85532af

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc81.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 594fb25570e2355c8cd753baa5de24da82dfe455778ae0d08bf9981cfc56aec5
MD5 d3bb500ef97fd9318c8292f155f7d32c
BLAKE2b-256 623cdef61462c8e909a3715445505ca1b87fb527bf299314d5a9dd35d6f6763e

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