sparq 0.2.5

Python client for the sparq api - automated degree planning for SJSU students + more

sparq Client

Python client library for the sparq API - automated degree planning for SJSU students.

Installation

pip install sparq

Quick Start

1. Get Your API Key

First, register and get your API key:

sparq auth

This will:

• Send a verification code to your email
• Generate your API key after verification
• Save it to ~/.sparq/config.txt

2. Generate a Degree Plan

Use the example script to test the API:

python sparq.py

Or use it in your own code:

from sparq import Sparq

# Initialize with your API key (automatically loaded from config)
client = Sparq()

# Generate a degree plan
plan = client.plan(
	major="Computer Science",
	cc_courses=[{"code": "COMSC 075", "title": "Computer Science I", "grade": "A", "institution": "Evergreen Valley College"}],
	units_per_semester=15,
	schedule_preferences={"avoid_hours": ["8:00 AM", "8:00 PM"]}
)

print(plan)

3. Check Your API Usage

View your API usage statistics:

sparq usage

4. Recover Lost API Key

If you lose your API key:

sparq recover

CLI Commands

• sparq auth - Register and get your API key
• sparq usage - View API usage statistics
• sparq recover - Recover your API key via email

Features

• Degree Planning: Generate semester-by-semester plans for SJSU majors
• Transfer Credit: Support for community college and AP credits
• Usage Tracking: Monitor your API calls and history
• API Key Recovery: Recover lost API keys via email verification

Updates

For updates please visit: https://github.com/shiventi/sparq/blob/main/docs/documentation.md

Support

For issues or questions, visit: https://github.com/shiventi/sparq