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

This project welcomes contributions and suggestions. For details, visit the repository's Contributor License Agreement (CLA) and Code of Conduct pages.

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.2rc59.post1.tar.gz (33.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.2rc59.post1-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for audioarxiv-0.1.2rc59.post1.tar.gz
Algorithm Hash digest
SHA256 636204915fa9e51f23f89c422e9cbb52635cc85f85a1135d634a657b083af97a
MD5 d5f0cb4a317fb0fd14f42573adbd689b
BLAKE2b-256 157ad90751bf1fb6eaba630a0d3aa1ad2eda331d47ba3e4ade1d6bdf491efd84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for audioarxiv-0.1.2rc59.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 688252be5b537bcccd6edd5d6c0e17af95e98a4b3b46236f86b0bf5e811a82d5
MD5 1c8321bcc7d111bddb8858d505785fd8
BLAKE2b-256 4afa029c95f8a94ceac640f7ef0c882188215de4cee7a4de8bc9f2757b70f43a

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