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.12 or 3.13. 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 and Groq address presets; custom compatible endpoints supported.
- Multi-subject coaching and subject-specific note retrieval.
- Paste notes or import UTF-8
.mdand.txtfiles 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
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.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| studytrails-0.2.1.tar.gz | 60.4 kB | Without provenance | Details for studytrails-0.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| studytrails-0.2.1-py3-none-any.whl | Python 3 | none | any | Details for studytrails-0.2.1-py3-none-any.whl |
Total release size: 83.9 kB
Release files / studytrails-0.2.1.tar.gz
| Download URL | studytrails-0.2.1.tar.gz |
|---|---|
| Size | 60.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5bef8ded8a25408b700fbf2e0a0106a0c0155e35e5dbf42994bfe9118d6523ce
|
|
BLAKE2b-256 checksum How to use checksums |
0a738c523f75e75c659bd8617656d26bba82f4b2d734e69c3e393a8131a1ee2b
|
| 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.1-py3-none-any.whl
| Download URL | studytrails-0.2.1-py3-none-any.whl |
|---|---|
| Size | 23.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
5bb565b15450fe1923ecf991c130f25f8ac961ed1d543fd8ddd21e900501f26d
|
|
BLAKE2b-256 checksum How to use checksums |
9fa09edc3752fde2e67b41708c69b155e1318ee5327883b5770b9b1b6edb950a
|
| 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.1
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.