Skip to main content

StudyTrail

Learn a little. Practise with purpose. See your progress.

StudyTrail is a terminal AI study coach. Bring your own compatible provider API key, add study notes, practise with quizzes, and track progress locally.

Requires Python 3.10 through 3.14. Install the latest release in an activated environment with python -m pip install --upgrade studytrails, or install an isolated CLI with uv tool install --upgrade studytrails. Run studytrails to open the welcome menu.

Created by Yash Patil, a Python and AI learner. The project uses OpenAI's Python SDK for compatible chat APIs. OpenAI created the GPT-OSS model family; the API host may be another provider, such as Groq. Users may configure other model families.

Features

  • Interactive provider, model, and hidden API-key setup.
  • OpenAI-compatible Chat Completions endpoints with tool-calling models.
  • OpenAI, Groq, and DeepSeek presets; custom compatible endpoints supported.
  • Formatted coach answers with readable headings, lists, and code blocks.
  • Explicit y/n prompts with input validation and a safe default of no.
  • Multi-subject coaching and subject-specific note retrieval.
  • Paste notes or import UTF-8 .md and .txt files up to 200 KB.
  • Multiple-choice quizzes, explanations, and local SQLite progress.
  • A fixed offline Python quiz demo that needs no API key.
  • Keys stored in supported operating-system credential stores, without a plaintext fallback.

Commands

studytrails
studytrails config
studytrails chat --subject java
studytrails notes-add
studytrails notes "inheritance" --subject java
studytrails scores
studytrails pending
studytrails demo
studytrails doctor
studytrails --version

Run studytrails doctor to see the personal storage location. Existing source checkouts retain their original data directories. Set STUDYTRAIL_HOME to choose a different root. Machines without a usable OS credential store can supply STUDYTRAIL_API_KEY through the environment.

The software is MIT-licensed. API costs and limits depend on your provider and plan; StudyTrail cannot guarantee free API usage. Your prompts, retrieved note passages, and score summaries may be sent to the configured provider. Notes are retrieved by keywords, not used to train a model. AI answers and quiz keys may contain mistakes. The app does not execute generated code. Native APIs with incompatible request formats are not supported. A provider preset does not guarantee every model works.

Metadata

Release files for studytrails 0.2.3

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

Source distribution (sdist)

Source distribution for studytrails 0.2.3
File Size Uploaded Provenance Actions
studytrails-0.2.3.tar.gz 86.0 kB Without provenance Details for studytrails-0.2.3.tar.gz

Built distribution (wheel)

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

Total release size: 111.0 kB

Release files / studytrails-0.2.3.tar.gz

Download URL studytrails-0.2.3.tar.gz
Size 86.0 kB
Tags Source
SHA-256 checksum
How to use checksums
d38a25350d19d954396ba9199bad802c2f786a4fb535d46d1c70ad8609276bd4
BLAKE2b-256 checksum
How to use checksums
739f10a2b40f66301a2482bea43953f2edb3b54be777a99f0e462af80e1c8f11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / studytrails-0.2.3-py3-none-any.whl

Download URL studytrails-0.2.3-py3-none-any.whl
Size 25.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4c1ac0f259f5a4dd80f8d422594f4b606990f16468499cebe7bb177c2df7e429
BLAKE2b-256 checksum
How to use checksums
a04356ee305541b3b60ef7bd08396e7882aa719ceaab9d14af300ca647050953
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Security for studytrails 0.2.3

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