Skip to main content

PreLing

PreLing is a command-line tool for improving language comprehension skills through gradual exposure to new vocabulary. It supports every language that spaCy supports. Because PreLing uses GPT under the hood, you must have a paid OpenAI account and an API key to run it.

Installation

Install Python 3.12 or later and pipx, then run:

pipx install preling          # install
pipx install "preling[ja]"    # alternatively: install with Japanese support
pipx upgrade preling          # upgrade
pipx uninstall preling        # uninstall (hopefully you won't need this)

Initialize a New Language

Prepare a plain-text file that contains one sentence per line in the language you want to learn. For example, you can download a monolingual corpus from OPUS. Then run:

preling init <lang> <corpus>

<lang> is the language code, and <corpus> is the path to the corpus file.

Study a Language

preling study <lang> [--audio] [--audio-only] [--model <GPT_MODEL>] \
               [--tts-model <TTS_MODEL>] [--api-key <OPENAI_KEY>] [--tts-api-key <OPENAI_OR_GCLOUD_KEY>]
  • <lang> – the language code you initialized earlier.
  • --audio – play audio along with the text.
  • --audio-only – play audio without displaying the text.
  • --tts-locale – the locale for text-to-speech (e.g., en-US, ja-JP); required for Gemini models.
  • --model – the GPT model to use for grammar evaluation.
  • --tts-model – the text-to-speech model to use for audio playback.
  • --api-key – your OpenAI API key.
  • --tts-api-key – your OpenAI API key for text-to-speech, or path to Google Cloud service account JSON file for Gemini models.

Instead of passing these options each time, you can set the environment variables PRELING_API_KEY, PRELING_MODEL, PRELING_TTS_API_KEY, and PRELING_TTS_MODEL.

View Your Progress

preling stats <lang>

Other Commands

preling path <lang>               # show the path to the language data file
preling delete <lang> [--force]   # delete the language data file; use --force to skip the confirmation prompt

Metadata

Release files for preling 1.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for preling 1.7.0
File Size Uploaded Provenance Actions
preling-1.7.0.tar.gz 20.4 kB Without provenance Details for preling-1.7.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for preling 1.7.0
File Interpreter ABI Platform Actions
preling-1.7.0-py3-none-any.whl Python 3 none any Details for preling-1.7.0-py3-none-any.whl

Total release size: 46.0 kB

Release files / preling-1.7.0.tar.gz

Download URL preling-1.7.0.tar.gz
Size 20.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3cb27bfb232c506ac692895013d09b9a31836c0057c7b2bc049a97c25eaf456c
BLAKE2b-256 checksum
How to use checksums
28486c1cddb859854502a7d90869088c2c269859fc65b14e5eb0222acdf17bab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / preling-1.7.0-py3-none-any.whl

Download URL preling-1.7.0-py3-none-any.whl
Size 25.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4c6c74ca7d077c659963624cc4b3f66430e8eb458bd6156a99844a3ecfd31595
BLAKE2b-256 checksum
How to use checksums
6be9f2076bd4001459eef5ff24152973f753251b49077df69e57dfc70ad99561
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Security for preling 1.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page