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.1rc58.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.1rc58.post1-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file audioarxiv-0.1.1rc58.post1.tar.gz.

File metadata

  • Download URL: audioarxiv-0.1.1rc58.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.1rc58.post1.tar.gz
Algorithm Hash digest
SHA256 774a835be984c5e3959b210f02eddfcc0bc415dc2d0675da1a86159360466a7e
MD5 0c1f425f5b04d001baa86c5c332ad244
BLAKE2b-256 909d0a3e80e6833d1b17d38ef5248eaf894902026a416c9f3067fab7f7310c4a

See more details on using hashes here.

File details

Details for the file audioarxiv-0.1.1rc58.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for audioarxiv-0.1.1rc58.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 f6c4ba7303eeab434f321d48774beaae077844fb545d1a20cda9870e9a2ee132
MD5 dd5b8e8f60433ef6077bd85e7217c2d8
BLAKE2b-256 b8cc44ad3cd84e8c4b10d27ecc3e5ddec8c8a603fd730f28093dd0c187d88e84

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