Metadata-Version: 2.4
Name: gt-scheduler-agent-cli
Version: 0.1.0
Summary: Independent agent-oriented CLI for Georgia Tech course planning
Project-URL: Homepage, https://github.com/BrandonLee28/gt-scheduler-agent-cli
Project-URL: Repository, https://github.com/BrandonLee28/gt-scheduler-agent-cli
Project-URL: Issues, https://github.com/BrandonLee28/gt-scheduler-agent-cli/issues
Project-URL: Changelog, https://github.com/BrandonLee28/gt-scheduler-agent-cli/blob/main/CHANGELOG.md
Author: Brandon Davidson
License: MIT License
        
        Copyright (c) 2026 Brandon Davidson
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: ai-agents,cli,course-planning,georgia-tech
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Education
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Requires-Dist: platformdirs>=4
Requires-Dist: pydantic>=2
Requires-Dist: typer>=0.12
Description-Content-Type: text/markdown

# GT Scheduler Agent CLI

An independent, agent-oriented CLI for Georgia Tech course planning. This
project is not affiliated with Georgia Tech or the GT Scheduler project.

The CLI does not log in to GT, register classes, or make degree-path decisions.

## Quick install (macOS/Linux)

If you already have [uv](https://docs.astral.sh/uv/) installed:

```bash
curl -fsSL https://raw.githubusercontent.com/BrandonLee28/gt-scheduler-agent-cli/main/install.sh | sh
```

The installer checks for `uv` and installs the `gt-agent` command from PyPI. It
does not silently install tools or upload local/student data.

## Install with pipx or pip

```bash
pipx install gt-scheduler-agent-cli
```

```bash
python -m pip install gt-scheduler-agent-cli
```

Windows users can use either of these Python-based installation methods.

## Install

```bash
python3 -m venv .venv
. .venv/bin/activate
pip install -e .
```

## Examples

```bash
gt-agent terms --json
gt-agent classes search "machine learning" --term 202608 --json
gt-agent classes show 91421 --term 202608 --json
gt-agent schedule plan --request plan.json --json
gt-agent grades course CS 4641 --json
gt-agent grades instructor "Jane Doe" --course "CS 4641" --json
```

The installed executable is `gt-agent`; all commands below are shown with that
name.

The agent can extract a student's current classes from a screenshot and pass
them as `fixed_meetings` in a planning request. The CLI does not ingest or
persist registration exports.

## Planning requests

`gt-agent schedule plan` accepts a versioned JSON request from a file or stdin:

```json
{
  "version": "1",
  "term": "202608",
  "requested_courses": [
    {"course": "CS 1331", "pinned_section": "A"},
    {"course": "MATH 1554"}
  ],
  "constraints": {
    "fixed_meetings": [
      {"label": "Current class", "days": ["Monday"], "start": "10:00 AM", "end": "11:00 AM"}
    ],
    "minimum_transition_minutes": 10
  },
  "preferences": {
    "preferred_instructors": ["Jane Doe"],
    "modalities": ["In Person"]
  },
  "max_results": 10,
  "include_grade_history": false
}
```

Options are ranked by fewer active days, then less idle time, then requested
soft preferences. Lecture/lab pairings inferred from public metadata are
marked as requiring manual verification. Prerequisites, corequisites, and
restrictions are evidence warnings, not registration decisions.

## Data sources

- Public term datasets published by [GT Scheduler](https://github.com/gt-scheduler/crawler-v2).
- Public course and instructor history from [Course Critique](https://www.critique.gatech.edu/).

If a network source is unavailable, the CLI uses its last successful cache and
marks the JSON response as stale.

## Documentation

- [Command reference](docs/cli.md)
- [Planning request and response schema](docs/planning-schema.md)
- [Contributing](CONTRIBUTING.md)
- [Security and privacy](SECURITY.md)
- [Changelog](CHANGELOG.md)

## License

MIT. See [LICENSE](LICENSE).
