Skip to main content

SoferAI's Torah Downloader

Project description

torah-dl - tools for downloading media from Torah websites.

uv PyPI - Version image image Actions status Coverage Status

Why torah-dl?

Most of our generation's Torah content is locked up in websites that are not easily accessible. Sofer.Ai is building a platform to make Torah accessible to everyone, and we decided to build key parts of that platform in the open. We intend to support every website with Torah audio on our platform, and realized quickly that even finding all the sites with audio would be a full-time job. So we open-sourced torah-dl to make it easier for others to download Torah audio from any website, and make Torah more accessible!

How does it work?

torah-dl is a library and a set of command-line tools for downloading media from Torah websites. You can use it as a command-line tool with uv (preferred), pipx, pip, poetry, venv, or any Python tool installer of your choice, simply by running uv tool install "torah-dl[cli]", and then running torah-dl.

For those who want to integrate torah-dl into their Python application, you can simply install it via uv add torah-dl or pip install torah-dl. You can then use the library in your code as you would any other Python library:

from torah_dl import extract

extraction = extract("https://www.yutorah.org/lectures/details?shiurid=1117416")

print(extraction.download_url) # https://download.yutorah.org/2024/34263/1117416/ketuvot-57a-b---preparation-for-nisuin.mp3

print(extraction.title) # Ketuvot 57a-b - Preparation for Nisuin

print(extraction.file_format) # audio/mp3

print(extraction.file_name) # ketuvot-57a-b---preparation-for-nisuin.mp3

What sites does it support?

Here is the list of sites that torah-dl supports already, and what's coming soon:

Contributing

We'd love your help! Please see our CONTRIBUTING.md for more information on how to get involved.

Frequently Asked Questions

Am I allowed to download Torah audio from these websites?

You are responsible for ensuring that you follow all Terms of Service agreements, Copyright agreements, and other legal agreements with these websites.

TODO: get a lawyer to review this.

How do I download audio from a site that is not on the list?

We'd love your help! Please see our CONTRIBUTING.md for more information on how to get involved.

What are the usecases for `torah-dl`?

Allowing transcription services to make Torah more accessible 😉

Other uses include downloading Torah audio for offline listening, or for use in Torah study tools, or for training AI models to understand Torah, or for other purposes (please see question above about permissions).

Contributors

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

torah_dl-0.5.0.tar.gz (81.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

torah_dl-0.5.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file torah_dl-0.5.0.tar.gz.

File metadata

  • Download URL: torah_dl-0.5.0.tar.gz
  • Upload date:
  • Size: 81.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for torah_dl-0.5.0.tar.gz
Algorithm Hash digest
SHA256 d3ad584bda8f43d6bf650600ea63d83bd0831d3f41927295cc61b81e4398e09c
MD5 3c771df5332ffab3367dfbcdd5f7c944
BLAKE2b-256 d2a6e6e3b32e04ba8e9cea826741d9107277aa22472f902705e174637641de50

See more details on using hashes here.

Provenance

The following attestation bundles were made for torah_dl-0.5.0.tar.gz:

Publisher: release.yml on SoferAi/torah-dl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file torah_dl-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: torah_dl-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for torah_dl-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 21e7042577c1a0cb9abee237d28e2b8c6e0ae18527bfb1d70b090a894ddfe9be
MD5 208a3ee8d373a7f4c03f063b828060d7
BLAKE2b-256 42f9e73d441e7adcbaab1afad44b680e7fafbe4eb22f6cb4e3d272f790e8bdef

See more details on using hashes here.

Provenance

The following attestation bundles were made for torah_dl-0.5.0-py3-none-any.whl:

Publisher: release.yml on SoferAi/torah-dl

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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