studytrails 0.2.1__tar.gz → 0.2.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {studytrails-0.2.1 → studytrails-0.2.2}/PKG-INFO +3 -3
- {studytrails-0.2.1 → studytrails-0.2.2}/README.md +1 -1
- {studytrails-0.2.1 → studytrails-0.2.2}/docs/PYPI.md +1 -1
- {studytrails-0.2.1 → studytrails-0.2.2}/docs/RELEASING.md +1 -1
- {studytrails-0.2.1 → studytrails-0.2.2}/docs/SETUP.md +9 -6
- {studytrails-0.2.1 → studytrails-0.2.2}/pyproject.toml +2 -2
- studytrails-0.2.2/uv.lock +872 -0
- studytrails-0.2.1/uv.lock +0 -593
- {studytrails-0.2.1 → studytrails-0.2.2}/.gitignore +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/.python-version +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/CONTRIBUTING.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/LICENSE +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/assets/banner.svg +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/assets/logo.svg +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/docs/USER_GUIDE.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/__init__.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/__main__.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/agent.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/cli.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/config.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/default_notes/java/basics.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/default_notes/python/collections.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/default_notes/python/functions.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/default_notes/python/loops.md +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/demo.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/models.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/notes.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/onboarding.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/preferences.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/storage.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/study_agent/tools.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/conftest.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_agent.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_cli.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_config.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_onboarding.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_storage.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/test_tools.py +0 -0
- {studytrails-0.2.1 → studytrails-0.2.2}/tests/wheel_smoke.py +0 -0
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
Metadata-Version: 2.5
|
|
2
2
|
Name: studytrails
|
|
3
|
-
Version: 0.2.
|
|
3
|
+
Version: 0.2.2
|
|
4
4
|
Summary: A personal multi-subject AI study coach with tools, local progress, and an offline demo.
|
|
5
5
|
License-Expression: MIT
|
|
6
6
|
License-File: LICENSE
|
|
7
|
-
Requires-Python: <3.
|
|
7
|
+
Requires-Python: <3.15,>=3.10
|
|
8
8
|
Requires-Dist: keyring<26,>=25
|
|
9
9
|
Requires-Dist: openai<3,>=2.0
|
|
10
10
|
Requires-Dist: platformdirs<5,>=4
|
|
@@ -20,7 +20,7 @@ Learn a little. Practise with purpose. See your progress.
|
|
|
20
20
|
StudyTrail is a terminal AI study coach. Bring your own compatible provider API
|
|
21
21
|
key, add study notes, practise with quizzes, and track progress locally.
|
|
22
22
|
|
|
23
|
-
Requires Python 3.
|
|
23
|
+
Requires Python 3.10 through 3.14. Install the latest release in an activated
|
|
24
24
|
environment with `python -m pip install --upgrade studytrails`, or install an
|
|
25
25
|
isolated CLI with `uv tool install --upgrade studytrails`. Run `studytrails` to
|
|
26
26
|
open the welcome menu.
|
|
@@ -15,7 +15,7 @@ OpenAI's Python SDK for compatible chat APIs. OpenAI created the GPT-OSS model
|
|
|
15
15
|
family; the API host may be another provider, such as Groq, and users can select
|
|
16
16
|
other model families too.
|
|
17
17
|
|
|
18
|
-
**Python 3.
|
|
18
|
+
**Python 3.10–3.14 | Your choice of compatible AI provider | Local progress**
|
|
19
19
|
|
|
20
20
|
## Get started
|
|
21
21
|
|
|
@@ -5,7 +5,7 @@ Learn a little. Practise with purpose. See your progress.
|
|
|
5
5
|
StudyTrail is a terminal AI study coach. Bring your own compatible provider API
|
|
6
6
|
key, add study notes, practise with quizzes, and track progress locally.
|
|
7
7
|
|
|
8
|
-
Requires Python 3.
|
|
8
|
+
Requires Python 3.10 through 3.14. Install the latest release in an activated
|
|
9
9
|
environment with `python -m pip install --upgrade studytrails`, or install an
|
|
10
10
|
isolated CLI with `uv tool install --upgrade studytrails`. Run `studytrails` to
|
|
11
11
|
open the welcome menu.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# Releasing StudyTrail
|
|
2
2
|
|
|
3
3
|
The distribution name is `studytrails`; the import remains `study_agent`.
|
|
4
|
-
|
|
4
|
+
Versions 0.2.0 and 0.2.1 are published on PyPI. Version 0.2.2 is the next local candidate.
|
|
5
5
|
Build, tests, and CI do not publish a release.
|
|
6
6
|
|
|
7
7
|
## Before each release
|
|
@@ -9,14 +9,17 @@ You can use the offline demo without an API key.
|
|
|
9
9
|
|
|
10
10
|
## 1. Install Python
|
|
11
11
|
|
|
12
|
-
StudyTrail
|
|
12
|
+
StudyTrail supports Python **3.10, 3.11, 3.12, 3.13, and 3.14**. Python 3.12 is
|
|
13
|
+
shown in the commands below; replace `3.12` with your installed version when you
|
|
14
|
+
want to use another supported release. The `openai` library used by StudyTrail
|
|
15
|
+
requires Python 3.10 or newer.
|
|
13
16
|
|
|
14
17
|
- **Windows:** Install Python from [python.org](https://www.python.org/downloads/).
|
|
15
18
|
In the installer, enable **Add python.exe to PATH**. Then open a new PowerShell
|
|
16
19
|
window and check `py --version`.
|
|
17
|
-
- **macOS:** Install Python 3.
|
|
20
|
+
- **macOS:** Install Python 3.10–3.14 from [python.org](https://www.python.org/downloads/)
|
|
18
21
|
or your preferred package manager. Check `python3.12 --version`.
|
|
19
|
-
- **Linux:** Install Python 3.
|
|
22
|
+
- **Linux:** Install Python 3.10–3.14 and its `venv` support using your
|
|
20
23
|
distribution's package manager. Check `python3.12 --version`.
|
|
21
24
|
|
|
22
25
|
## 2. Install StudyTrail in its own environment
|
|
@@ -63,8 +66,8 @@ python -m pip install studytrails
|
|
|
63
66
|
studytrails
|
|
64
67
|
```
|
|
65
68
|
|
|
66
|
-
If your system's `python3.12` command has another name, use the command
|
|
67
|
-
|
|
69
|
+
If your system's `python3.12` command has another name, use the command for your
|
|
70
|
+
chosen supported Python version to create the environment.
|
|
68
71
|
|
|
69
72
|
### Optional: install uv
|
|
70
73
|
|
|
@@ -167,7 +170,7 @@ synchronized.
|
|
|
167
170
|
- **`studytrails` is not recognized / command not found:** activate the same
|
|
168
171
|
virtual environment where you installed it. With uv, open a new terminal after
|
|
169
172
|
`uv tool update-shell` and check uv's PATH instructions.
|
|
170
|
-
- **Python version error:**
|
|
173
|
+
- **Python version error:** use Python 3.10 through 3.14 and recreate the `.venv`
|
|
171
174
|
with that version.
|
|
172
175
|
- **PowerShell says scripts are disabled:** use the current-terminal command in
|
|
173
176
|
the Windows section above, then activate again.
|
|
@@ -4,12 +4,12 @@ build-backend = "hatchling.build"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "studytrails"
|
|
7
|
-
version = "0.2.
|
|
7
|
+
version = "0.2.2"
|
|
8
8
|
description = "A personal multi-subject AI study coach with tools, local progress, and an offline demo."
|
|
9
9
|
readme = "docs/PYPI.md"
|
|
10
10
|
license = "MIT"
|
|
11
11
|
license-files = ["LICENSE"]
|
|
12
|
-
requires-python = ">=3.
|
|
12
|
+
requires-python = ">=3.10,<3.15"
|
|
13
13
|
dependencies = [
|
|
14
14
|
"openai>=2.0,<3",
|
|
15
15
|
"pydantic>=2.0,<3",
|