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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for audioarxiv-0.1.2rc69.post1.tar.gz
Algorithm Hash digest
SHA256 bb1431a7456ff95241853d5261b961810da26d330f1d7adf7a0ed8790f999215
MD5 b6a56d94a1ed3668ad30f27b5ca6a85e
BLAKE2b-256 f54050ffd70f15545ca2e30d84c3a992d86b11243997276405368969368c723f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc69.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 889bed25184c6db6c01e750ee3848197a0df5b1658f5861d469bd35d6567b06e
MD5 19e3b4afa043a2e8c965b98e175bf55b
BLAKE2b-256 201a72b2387145504edb4be5c40d0d7c1306a22e4aebd9b9686a721ba7384adf

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