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

Uploaded Python 3

File details

Details for the file audioarxiv-0.1.0rc55.post1.tar.gz.

File metadata

  • Download URL: audioarxiv-0.1.0rc55.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.0rc55.post1.tar.gz
Algorithm Hash digest
SHA256 3a0798c114cadafd2ffe21474630210fd01b3c952571ce8b0b971a925a173e5d
MD5 4939aa5d168eeed248a46c483dd520eb
BLAKE2b-256 9e8260d3be9b84f276f4f3990835e5beeb6f9476a2f3996aec0b389c3fefbe19

See more details on using hashes here.

File details

Details for the file audioarxiv-0.1.0rc55.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for audioarxiv-0.1.0rc55.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 809c42bb4e73054b4f2cfb4cc072e1b38b1984d876c4f8db2f4bfbed7df64481
MD5 b6f45a55b3dba060c32cea72cac022e4
BLAKE2b-256 3d7ec968dfc8ea4dbe1c59ca1b8f0fafa972916409b3a78190a96a69dddac103

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