sparq 0.1.0__tar.gz → 0.1.1__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.
Files changed (18) hide show
  1. sparq-0.1.1/PKG-INFO +99 -0
  2. sparq-0.1.1/README.md +84 -0
  3. {sparq-0.1.0 → sparq-0.1.1}/pyproject.toml +3 -3
  4. sparq-0.1.1/sparq.egg-info/PKG-INFO +99 -0
  5. sparq-0.1.0/PKG-INFO +0 -23
  6. sparq-0.1.0/README.md +0 -8
  7. sparq-0.1.0/sparq.egg-info/PKG-INFO +0 -23
  8. {sparq-0.1.0 → sparq-0.1.1}/LICENSE +0 -0
  9. {sparq-0.1.0 → sparq-0.1.1}/auth.py +0 -0
  10. {sparq-0.1.0 → sparq-0.1.1}/client.py +0 -0
  11. {sparq-0.1.0 → sparq-0.1.1}/recover.py +0 -0
  12. {sparq-0.1.0 → sparq-0.1.1}/setup.cfg +0 -0
  13. {sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/SOURCES.txt +0 -0
  14. {sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/dependency_links.txt +0 -0
  15. {sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/requires.txt +0 -0
  16. {sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/top_level.txt +0 -0
  17. {sparq-0.1.0 → sparq-0.1.1}/sparq.py +0 -0
  18. {sparq-0.1.0 → sparq-0.1.1}/usage.py +0 -0
sparq-0.1.1/PKG-INFO ADDED
@@ -0,0 +1,99 @@
1
+ Metadata-Version: 2.4
2
+ Name: sparq
3
+ Version: 0.1.1
4
+ Summary: Python client for the sparq api - automated degree planning for SJSU students + more
5
+ Author-email: Shiven Sheth <shivsbots@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/shiventi/sparq
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Requires-Dist: requests>=2.25.0
14
+ Dynamic: license-file
15
+
16
+ # sparq Client
17
+
18
+ Python client library for the sparq API - automated degree planning for SJSU students.
19
+
20
+ ## Installation
21
+
22
+ ```bash
23
+ pip install sparq
24
+ ```
25
+
26
+ ## Quick Start
27
+
28
+ ### 1. Get Your API Key
29
+
30
+ First, run the authentication script to register and get your API key:
31
+
32
+ ```bash
33
+ python auth.py
34
+ ```
35
+
36
+ This will:
37
+ - Send a verification code to your email
38
+ - Generate your API key after verification
39
+ - Save it to `~/.sparq/config.txt`
40
+
41
+ ### 2. Generate a Degree Plan
42
+
43
+ Use the example script to test the API:
44
+
45
+ ```bash
46
+ python sparq.py
47
+ ```
48
+
49
+ Or use it in your own code:
50
+
51
+ ```python
52
+ from sparq import Sparq
53
+
54
+ # Initialize with your API key (automatically loaded from config)
55
+ client = Sparq()
56
+
57
+ # Generate a degree plan
58
+ plan = client.plan(
59
+ major="Computer Science",
60
+ cc_courses=[
61
+ {
62
+ "code": "COMSC 075",
63
+ "title": "Computer Science I",
64
+ "grade": "A",
65
+ "institution": "Evergreen Valley College"
66
+ }
67
+ ],
68
+ units_per_semester=15
69
+ )
70
+
71
+ print(plan)
72
+ ```
73
+
74
+ ### 3. Check Your API Usage
75
+
76
+ View your API usage statistics:
77
+
78
+ ```bash
79
+ python usage.py
80
+ ```
81
+
82
+ ### 4. Recover Lost API Key
83
+
84
+ If you lose your API key:
85
+
86
+ ```bash
87
+ python recover.py
88
+ ```
89
+
90
+ ## Features
91
+
92
+ - **Degree Planning**: Generate semester-by-semester plans for SJSU majors
93
+ - **Transfer Credit**: Support for community college and AP credits
94
+ - **Usage Tracking**: Monitor your API calls and history
95
+ - **API Key Recovery**: Recover lost API keys via email verification
96
+
97
+ ## Support
98
+
99
+ For issues or questions, visit: https://github.com/shiventi/sparq
sparq-0.1.1/README.md ADDED
@@ -0,0 +1,84 @@
1
+ # sparq Client
2
+
3
+ Python client library for the sparq API - automated degree planning for SJSU students.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pip install sparq
9
+ ```
10
+
11
+ ## Quick Start
12
+
13
+ ### 1. Get Your API Key
14
+
15
+ First, run the authentication script to register and get your API key:
16
+
17
+ ```bash
18
+ python auth.py
19
+ ```
20
+
21
+ This will:
22
+ - Send a verification code to your email
23
+ - Generate your API key after verification
24
+ - Save it to `~/.sparq/config.txt`
25
+
26
+ ### 2. Generate a Degree Plan
27
+
28
+ Use the example script to test the API:
29
+
30
+ ```bash
31
+ python sparq.py
32
+ ```
33
+
34
+ Or use it in your own code:
35
+
36
+ ```python
37
+ from sparq import Sparq
38
+
39
+ # Initialize with your API key (automatically loaded from config)
40
+ client = Sparq()
41
+
42
+ # Generate a degree plan
43
+ plan = client.plan(
44
+ major="Computer Science",
45
+ cc_courses=[
46
+ {
47
+ "code": "COMSC 075",
48
+ "title": "Computer Science I",
49
+ "grade": "A",
50
+ "institution": "Evergreen Valley College"
51
+ }
52
+ ],
53
+ units_per_semester=15
54
+ )
55
+
56
+ print(plan)
57
+ ```
58
+
59
+ ### 3. Check Your API Usage
60
+
61
+ View your API usage statistics:
62
+
63
+ ```bash
64
+ python usage.py
65
+ ```
66
+
67
+ ### 4. Recover Lost API Key
68
+
69
+ If you lose your API key:
70
+
71
+ ```bash
72
+ python recover.py
73
+ ```
74
+
75
+ ## Features
76
+
77
+ - **Degree Planning**: Generate semester-by-semester plans for SJSU majors
78
+ - **Transfer Credit**: Support for community college and AP credits
79
+ - **Usage Tracking**: Monitor your API calls and history
80
+ - **API Key Recovery**: Recover lost API keys via email verification
81
+
82
+ ## Support
83
+
84
+ For issues or questions, visit: https://github.com/shiventi/sparq
{sparq-0.1.0 → sparq-0.1.1}/pyproject.toml RENAMED
@@ -4,14 +4,14 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "sparq"
7
- version = "0.1.0"
7
+ version = "0.1.1"
8
8
  authors = [
9
- { name="Shiven Sheth" }
9
+ { name="Shiven Sheth", email="shivsbots@gmail.com" }
10
10
  ]
11
11
  description = "Python client for the sparq api - automated degree planning for SJSU students + more"
12
12
  readme = "README.md"
13
13
  requires-python = ">=3.8"
14
- license = {text = "MIT"}
14
+ license = "MIT"
15
15
  classifiers = [
16
16
  "Programming Language :: Python :: 3",
17
17
  "Operating System :: OS Independent",
sparq-0.1.1/sparq.egg-info/PKG-INFO ADDED
@@ -0,0 +1,99 @@
1
+ Metadata-Version: 2.4
2
+ Name: sparq
3
+ Version: 0.1.1
4
+ Summary: Python client for the sparq api - automated degree planning for SJSU students + more
5
+ Author-email: Shiven Sheth <shivsbots@gmail.com>
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/shiventi/sparq
8
+ Classifier: Programming Language :: Python :: 3
9
+ Classifier: Operating System :: OS Independent
10
+ Requires-Python: >=3.8
11
+ Description-Content-Type: text/markdown
12
+ License-File: LICENSE
13
+ Requires-Dist: requests>=2.25.0
14
+ Dynamic: license-file
15
+
16
+ # sparq Client
17
+
18
+ Python client library for the sparq API - automated degree planning for SJSU students.
19
+
20
+ ## Installation
21
+
22
+ ```bash
23
+ pip install sparq
24
+ ```
25
+
26
+ ## Quick Start
27
+
28
+ ### 1. Get Your API Key
29
+
30
+ First, run the authentication script to register and get your API key:
31
+
32
+ ```bash
33
+ python auth.py
34
+ ```
35
+
36
+ This will:
37
+ - Send a verification code to your email
38
+ - Generate your API key after verification
39
+ - Save it to `~/.sparq/config.txt`
40
+
41
+ ### 2. Generate a Degree Plan
42
+
43
+ Use the example script to test the API:
44
+
45
+ ```bash
46
+ python sparq.py
47
+ ```
48
+
49
+ Or use it in your own code:
50
+
51
+ ```python
52
+ from sparq import Sparq
53
+
54
+ # Initialize with your API key (automatically loaded from config)
55
+ client = Sparq()
56
+
57
+ # Generate a degree plan
58
+ plan = client.plan(
59
+ major="Computer Science",
60
+ cc_courses=[
61
+ {
62
+ "code": "COMSC 075",
63
+ "title": "Computer Science I",
64
+ "grade": "A",
65
+ "institution": "Evergreen Valley College"
66
+ }
67
+ ],
68
+ units_per_semester=15
69
+ )
70
+
71
+ print(plan)
72
+ ```
73
+
74
+ ### 3. Check Your API Usage
75
+
76
+ View your API usage statistics:
77
+
78
+ ```bash
79
+ python usage.py
80
+ ```
81
+
82
+ ### 4. Recover Lost API Key
83
+
84
+ If you lose your API key:
85
+
86
+ ```bash
87
+ python recover.py
88
+ ```
89
+
90
+ ## Features
91
+
92
+ - **Degree Planning**: Generate semester-by-semester plans for SJSU majors
93
+ - **Transfer Credit**: Support for community college and AP credits
94
+ - **Usage Tracking**: Monitor your API calls and history
95
+ - **API Key Recovery**: Recover lost API keys via email verification
96
+
97
+ ## Support
98
+
99
+ For issues or questions, visit: https://github.com/shiventi/sparq
sparq-0.1.0/PKG-INFO DELETED
@@ -1,23 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: sparq
3
- Version: 0.1.0
4
- Summary: Python client for the sparq api - automated degree planning for SJSU students + more
5
- Author: Shiven Sheth
6
- License: MIT
7
- Project-URL: Homepage, https://github.com/shiventi/sparq
8
- Classifier: Programming Language :: Python :: 3
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.8
11
- Description-Content-Type: text/markdown
12
- License-File: LICENSE
13
- Requires-Dist: requests>=2.25.0
14
- Dynamic: license-file
15
-
16
- # sparq Client
17
-
18
- Python client library for the sparq API - automated degree planning for SJSU students.
19
-
20
- ## Installation
21
-
22
- ```bash
23
- pip install sparq
sparq-0.1.0/README.md DELETED
@@ -1,8 +0,0 @@
1
- # sparq Client
2
-
3
- Python client library for the sparq API - automated degree planning for SJSU students.
4
-
5
- ## Installation
6
-
7
- ```bash
8
- pip install sparq
sparq-0.1.0/sparq.egg-info/PKG-INFO DELETED
@@ -1,23 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: sparq
3
- Version: 0.1.0
4
- Summary: Python client for the sparq api - automated degree planning for SJSU students + more
5
- Author: Shiven Sheth
6
- License: MIT
7
- Project-URL: Homepage, https://github.com/shiventi/sparq
8
- Classifier: Programming Language :: Python :: 3
9
- Classifier: Operating System :: OS Independent
10
- Requires-Python: >=3.8
11
- Description-Content-Type: text/markdown
12
- License-File: LICENSE
13
- Requires-Dist: requests>=2.25.0
14
- Dynamic: license-file
15
-
16
- # sparq Client
17
-
18
- Python client library for the sparq API - automated degree planning for SJSU students.
19
-
20
- ## Installation
21
-
22
- ```bash
23
- pip install sparq
{sparq-0.1.0 → sparq-0.1.1}/LICENSE RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/auth.py RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/client.py RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/recover.py RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/setup.cfg RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/SOURCES.txt RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/sparq.egg-info/requires.txt RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/sparq.py RENAMED
File without changes
{sparq-0.1.0 → sparq-0.1.1}/usage.py RENAMED
File without changes