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

Uploaded Python 3

File details

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

File metadata

  • Download URL: audioarxiv-0.1.2rc73.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.2rc73.post1.tar.gz
Algorithm Hash digest
SHA256 4fae92418ac94b56c6c20b37d11ea17bd3bf183f3b9338af741b0575a7d7c8e4
MD5 25a066a007995317b49d1a5fddfb79b5
BLAKE2b-256 1e317027d5daf67adb55822ede53c0e2f3d927d1d10b5c2c98da124f0d97793e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc73.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 994b14255d6465af2fb204fd7c42713c36a2860759f03e353e64e0f246310913
MD5 c98e17286a598ef18d65fe382d47bfc4
BLAKE2b-256 ed6b36916831678e150736f762a88ba280179e7222cfb8d7013225c9683500df

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