sparq 0.1.0__tar.gz

sparq-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shiven Sheth
+
+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.

sparq-0.1.0/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: sparq
+Version: 0.1.0
+Summary: Python client for the sparq api - automated degree planning for SJSU students + more
+Author: Shiven Sheth
+License: MIT
+Project-URL: Homepage, https://github.com/shiventi/sparq
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+# sparq Client
+
+Python client library for the sparq API - automated degree planning for SJSU students.
+
+## Installation
+
+```bash
+pip install sparq

sparq-0.1.0/README.md

@@ -0,0 +1,8 @@
+# sparq Client
+
+Python client library for the sparq API - automated degree planning for SJSU students.
+
+## Installation
+
+```bash
+pip install sparq

sparq-0.1.0/auth.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+
+import requests
+import os
+from pathlib import Path
+
+API_URL = "https://sparq-api.onrender.com"
+
+def save_api_key(api_key, email):
+    config_dir = Path.home() / ".sparq"
+    config_dir.mkdir(exist_ok=True)
+    config_file = config_dir / "config.txt"
+    
+    with open(config_file, "w") as f:
+        f.write(f"API_KEY={api_key}\n")
+        f.write(f"EMAIL={email}\n")
+    
+    print(f"\nAPI key saved to {config_file}")
+
+def register():
+    email = input("Email: ").strip()
+    
+    if not email or "@" not in email:
+        print("Invalid email address")
+        return
+    
+    response = requests.post(
+        f"{API_URL}/register",
+        json={"email": email},
+        headers={"Content-Type": "application/json"}
+    )
+    
+    if response.status_code == 200:
+        data = response.json()
+        if data.get("status") == "pending_verification":
+            print("Code already sent. Check your email.")
+        else:
+            print("Verification code sent to your email")
+    elif response.status_code != 200:
+        print(response.json()['detail'])
+        return
+    
+    code = input("Enter code: ").strip()
+    
+    response = requests.post(
+        f"{API_URL}/verify",
+        json={"email": email, "code": code},
+        headers={"Content-Type": "application/json"}
+    )
+    
+    if response.status_code == 200:
+        api_key = response.json()["api_key"]
+        print(f"\nAPI Key: {api_key}")
+        save_api_key(api_key, email)
+    else:
+        print(response.json()['detail'])
+
+if __name__ == "__main__":
+    register()
+

sparq-0.1.0/client.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+
+import requests
+from pathlib import Path
+
+API_URL = "https://sparq-api.onrender.com"
+
+class Sparq:
+    def __init__(self, api_key=None):
+        if api_key:
+            self.api_key = api_key
+        else:
+            self.api_key = self._load_api_key()
+    
+    def _load_api_key(self):
+        config_file = Path.home() / ".sparq" / "config.txt"
+        if config_file.exists():
+            with open(config_file, "r") as f:
+                for line in f:
+                    if line.startswith("API_KEY="):
+                        return line.strip().split("=", 1)[1]
+        return None
+    
+    def plan(self, major, cc_courses=None, ap_exams=None, sjsu_courses=None, units_per_semester=15):
+        if not self.api_key:
+            raise Exception("No API key found. Run auth.py first.")
+        
+        payload = {
+            "major": major,
+            "cc_courses": cc_courses or [],
+            "ap_exams": ap_exams or [],
+            "sjsu_courses": sjsu_courses or [],
+            "units_per_semester": units_per_semester
+        }
+        
+        response = requests.post(
+            f"{API_URL}/plan",
+            json=payload,
+            headers={
+                "Content-Type": "application/json",
+                "x-api-key": self.api_key
+            }
+        )
+        
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f"Error: {response.json().get('detail', 'Unknown error')}")
+    
+    def usage(self):
+        """Get API usage statistics for the authenticated user."""
+        if not self.api_key:
+            raise Exception("No API key found. Run auth.py first.")
+        
+        response = requests.get(
+            f"{API_URL}/usage",
+            params={"x_api_key": self.api_key}
+        )
+        
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f"Error: {response.json().get('detail', 'Unknown error')}")

sparq-0.1.0/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sparq"
+version = "0.1.0"
+authors = [
+    { name="Shiven Sheth" }
+]
+description = "Python client for the sparq api - automated degree planning for SJSU students + more"
+readme = "README.md"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests>=2.25.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/shiventi/sparq"
+
+[tool.setuptools]
+py-modules = ["client", "auth", "recover", "usage", "sparq"]

sparq-0.1.0/recover.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+import requests
+from pathlib import Path
+
+API_URL = "https://sparq-api.onrender.com"
+
+def save_api_key(api_key, email):
+    config_dir = Path.home() / ".sparq"
+    config_dir.mkdir(exist_ok=True)
+    config_file = config_dir / "config.txt"
+    
+    with open(config_file, "w") as f:
+        f.write(f"API_KEY={api_key}\n")
+        f.write(f"EMAIL={email}\n")
+    
+    print(f"\nAPI key saved to {config_file}")
+
+def recover():
+    email = input("Email: ").strip()
+    
+    if not email or "@" not in email:
+        print("Invalid email address")
+        return
+    
+    response = requests.post(
+        f"{API_URL}/recover",
+        json={"email": email},
+        headers={"Content-Type": "application/json"}
+    )
+    
+    if response.status_code != 200:
+        print(response.json()['detail'])
+        return
+    
+    print("Verification code sent to your email")
+    
+    code = input("Enter code: ").strip()
+    
+    response = requests.post(
+        f"{API_URL}/recover",
+        json={"email": email, "code": code},
+        headers={"Content-Type": "application/json"}
+    )
+    
+    if response.status_code == 200:
+        api_key = response.json()["api_key"]
+        print(f"\nAPI Key: {api_key}")
+        save_api_key(api_key, email)
+    else:
+        print(response.json()['detail'])
+
+if __name__ == "__main__":
+    recover()

sparq-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sparq-0.1.0/sparq.egg-info/PKG-INFO

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: sparq
+Version: 0.1.0
+Summary: Python client for the sparq api - automated degree planning for SJSU students + more
+Author: Shiven Sheth
+License: MIT
+Project-URL: Homepage, https://github.com/shiventi/sparq
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.25.0
+Dynamic: license-file
+
+# sparq Client
+
+Python client library for the sparq API - automated degree planning for SJSU students.
+
+## Installation
+
+```bash
+pip install sparq

sparq-0.1.0/sparq.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+auth.py
+client.py
+pyproject.toml
+recover.py
+sparq.py
+usage.py
+sparq.egg-info/PKG-INFO
+sparq.egg-info/SOURCES.txt
+sparq.egg-info/dependency_links.txt
+sparq.egg-info/requires.txt
+sparq.egg-info/top_level.txt

sparq-0.1.0/sparq.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sparq-0.1.0/sparq.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.25.0

sparq-0.1.0/sparq.egg-info/top_level.txt

@@ -0,0 +1,5 @@
+auth
+client
+recover
+sparq
+usage

sparq-0.1.0/sparq.py

@@ -0,0 +1,39 @@
+from client import Sparq
+
+client = Sparq("your-api-key-here")
+
+# edit accordingly
+plan = client.plan(
+    major= "Computer Science",
+    cc_courses= [
+        # EVC Courses (based on actual transcript)
+        {"code": "COMSC 075", "title": "Computer Science I", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "COMSC 076", "title": "Computer Science II", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "COMS 020", "title": "Oral Communication", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "ART 096", "title": "History of Asian Art", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "COMS 035", "title": "Intercultural Communication", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "PSYCH 001", "title": "General Psychology", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "PHIL 060", "title": "Logic and Critical Thinking", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "PHIL 010", "title": "Introduction to Philosophy", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "PHIL 065", "title": "Introduction to Ethics", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "COMSC 080", "title": "Discrete Structures", "grade": "A", "institution": "Evergreen Valley College"},
+        {"code": "HIST 017A", "title": "History of the United States", "grade": "A", "institution": "Evergreen Valley College"},
+        # SJCC Courses
+        {"code": "ENGL 001A", "title": "English Composition", "grade": "A", "institution": "San Jose City College"},
+    ],
+    ap_exams= [
+        {"test": "Calculus AB", "score": 5},
+        {"test": "Calculus BC", "score": 4},
+        {"test": "World History", "score": 4},
+        {"test": "Physics C, Mechanics", "score": 4},
+    ],
+    sjsu_courses= [
+        {"code": "MATH 32", "title": "Calculus III", "status": "In Progress", "term": "Fall 2025"},
+        {"code": "CS 49J", "title": "Programming in Java", "status": "In Progress", "term": "Fall 2025"},
+        {"code": "NUFS 16", "title": "Nutrition", "status": "In Progress", "term": "Fall 2025"},
+        {"code": "METR 10", "title": "Weather and Climate", "status": "In Progress", "term": "Fall 2025"},
+    ],
+    units_per_semester= 15
+)
+
+print(plan)

sparq-0.1.0/usage.py

@@ -0,0 +1,55 @@
+import requests
+from pathlib import Path
+
+API_URL = "http://localhost:8000"
+
+def load_api_key():
+    config_path = Path.home() / ".sparq" / "config.txt"
+    if not config_path.exists():
+        return None
+    with open(config_path, "r") as f:
+        for line in f:
+            if line.startswith("API_KEY="):
+                return line.strip().split("=", 1)[1]
+    return None
+
+def view_usage(api_key=None):
+    if not api_key:
+        api_key = load_api_key()
+        if not api_key:
+            print("No API key found. Please run auth.py to register first.")
+            return
+    
+    try:
+        response = requests.get(
+            f"{API_URL}/usage",
+            headers={"x-api-key": api_key}
+        )
+        
+        if response.status_code == 200:
+            data = response.json()
+            
+            print(f"\nEmail: {data['email']}")
+            print(f"Total API Calls: {data['total_api_calls']}\n")
+            
+            if data['recent_calls']:
+                print("Recent Calls:")
+                for i, call in enumerate(data['recent_calls'], 1):
+                    major = call.get('request_data', {}).get('major', 'N/A') if call.get('request_data') else 'N/A'
+                    print(f"  {i}. {call['endpoint']} | {call['response_status']} | {major} | {call['created_at']}")
+            else:
+                print("No API calls recorded yet.\n")
+        
+        elif response.status_code == 401:
+            print("Invalid or inactive API key")
+        else:
+            print(f"Error: {response.json().get('detail', 'Unknown error')}")
+    
+    except requests.exceptions.ConnectionError:
+        print(f"Cannot connect to API at {API_URL}")
+        print("Make sure the server is running")
+    except Exception as e:
+        print(f"Error: {e}")
+
+if __name__ == "__main__":
+    view_usage()