aloc-sdk 1.0.0__py3-none-any.whl

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 (86) hide show
  1. aloc_sdk/__init__.py +234 -0
  2. aloc_sdk/api/__init__.py +12 -0
  3. aloc_sdk/api/assessments_api.py +888 -0
  4. aloc_sdk/api/benchmarks_api.py +861 -0
  5. aloc_sdk/api/explanations_api.py +342 -0
  6. aloc_sdk/api/health_api.py +281 -0
  7. aloc_sdk/api/intelligence_api.py +651 -0
  8. aloc_sdk/api/metadata_api.py +704 -0
  9. aloc_sdk/api/questions_api.py +1042 -0
  10. aloc_sdk/api/subjects_api.py +1774 -0
  11. aloc_sdk/api_client.py +820 -0
  12. aloc_sdk/api_response.py +21 -0
  13. aloc_sdk/configuration.py +648 -0
  14. aloc_sdk/exceptions.py +219 -0
  15. aloc_sdk/models/__init__.py +82 -0
  16. aloc_sdk/models/create_assessment_session201_response.py +99 -0
  17. aloc_sdk/models/create_assessment_session201_response_data.py +99 -0
  18. aloc_sdk/models/create_assessment_session_request.py +129 -0
  19. aloc_sdk/models/curriculum_node.py +117 -0
  20. aloc_sdk/models/cursor_pagination.py +103 -0
  21. aloc_sdk/models/error.py +97 -0
  22. aloc_sdk/models/exam_session.py +95 -0
  23. aloc_sdk/models/explain_question200_response.py +99 -0
  24. aloc_sdk/models/explain_question_request.py +99 -0
  25. aloc_sdk/models/explanation.py +106 -0
  26. aloc_sdk/models/explanation_common_mistakes_inner.py +91 -0
  27. aloc_sdk/models/find_similar_questions200_response.py +103 -0
  28. aloc_sdk/models/find_similar_questions200_response_data_inner.py +96 -0
  29. aloc_sdk/models/generate_assessment200_response.py +99 -0
  30. aloc_sdk/models/generate_assessment200_response_data.py +118 -0
  31. aloc_sdk/models/generate_assessment200_response_data_difficulty_breakdown.py +93 -0
  32. aloc_sdk/models/generate_assessment_request.py +137 -0
  33. aloc_sdk/models/generate_assessment_request_difficulty_distribution.py +93 -0
  34. aloc_sdk/models/get_assessment_session_questions200_response.py +103 -0
  35. aloc_sdk/models/get_benchmark_sample_questions200_response.py +99 -0
  36. aloc_sdk/models/get_benchmark_sample_questions200_response_data.py +101 -0
  37. aloc_sdk/models/get_benchmark_subjects200_response.py +103 -0
  38. aloc_sdk/models/get_benchmark_subjects200_response_data_inner.py +93 -0
  39. aloc_sdk/models/get_curriculum200_response.py +103 -0
  40. aloc_sdk/models/get_exam_trends200_response.py +99 -0
  41. aloc_sdk/models/get_public_metrics200_response.py +99 -0
  42. aloc_sdk/models/get_public_metrics200_response_data.py +91 -0
  43. aloc_sdk/models/get_question200_response.py +99 -0
  44. aloc_sdk/models/get_subject200_response.py +99 -0
  45. aloc_sdk/models/get_subjects_call_counts200_response.py +103 -0
  46. aloc_sdk/models/get_subjects_call_counts200_response_data_inner.py +91 -0
  47. aloc_sdk/models/get_topic_benchmarks200_response.py +99 -0
  48. aloc_sdk/models/get_topic_benchmarks200_response_data.py +117 -0
  49. aloc_sdk/models/get_topic_benchmarks200_response_data_difficulty_distribution.py +99 -0
  50. aloc_sdk/models/get_topic_benchmarks200_response_data_topics_inner.py +125 -0
  51. aloc_sdk/models/get_topic_benchmarks200_response_data_topics_inner_difficulty_distribution.py +99 -0
  52. aloc_sdk/models/get_topic_benchmarks200_response_data_topics_inner_year_breakdown_inner.py +91 -0
  53. aloc_sdk/models/get_topic_benchmarks200_response_data_year_range.py +91 -0
  54. aloc_sdk/models/health_check200_response.py +94 -0
  55. aloc_sdk/models/list_questions200_response.py +109 -0
  56. aloc_sdk/models/list_subjects200_response.py +103 -0
  57. aloc_sdk/models/list_subjects_for_year200_response.py +103 -0
  58. aloc_sdk/models/list_subjects_for_year200_response_data_inner.py +99 -0
  59. aloc_sdk/models/list_topics200_response.py +103 -0
  60. aloc_sdk/models/list_years_for_subject200_response.py +103 -0
  61. aloc_sdk/models/list_years_for_subject200_response_data_inner.py +95 -0
  62. aloc_sdk/models/metadata.py +100 -0
  63. aloc_sdk/models/question.py +261 -0
  64. aloc_sdk/models/question_options.py +97 -0
  65. aloc_sdk/models/question_provenance.py +141 -0
  66. aloc_sdk/models/question_with_metadata.py +202 -0
  67. aloc_sdk/models/report_question201_response.py +95 -0
  68. aloc_sdk/models/report_question201_response_data.py +92 -0
  69. aloc_sdk/models/report_question_request.py +101 -0
  70. aloc_sdk/models/response_meta.py +106 -0
  71. aloc_sdk/models/subject.py +125 -0
  72. aloc_sdk/models/subject_detail.py +129 -0
  73. aloc_sdk/models/subject_features.py +93 -0
  74. aloc_sdk/models/subject_year_range.py +91 -0
  75. aloc_sdk/models/topic.py +103 -0
  76. aloc_sdk/models/topic_subtopics_inner.py +93 -0
  77. aloc_sdk/models/trend_analysis.py +117 -0
  78. aloc_sdk/models/trend_analysis_difficulty_trend_inner.py +91 -0
  79. aloc_sdk/models/trend_analysis_most_tested_topics_inner.py +91 -0
  80. aloc_sdk/models/trend_analysis_year_range.py +91 -0
  81. aloc_sdk/py.typed +0 -0
  82. aloc_sdk/rest.py +314 -0
  83. aloc_sdk-1.0.0.dist-info/METADATA +168 -0
  84. aloc_sdk-1.0.0.dist-info/RECORD +86 -0
  85. aloc_sdk-1.0.0.dist-info/WHEEL +5 -0
  86. aloc_sdk-1.0.0.dist-info/top_level.txt +1 -0
aloc_sdk/__init__.py ADDED
@@ -0,0 +1,234 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ ALOC Public API
7
+
8
+ Assessment content infrastructure API for African EdTech. ALOC provides structured, enriched, curriculum-aligned examination content spanning WAEC, JAMB, and NECO syllabi (2010–2024), with topic classification, difficulty scores, AI-generated explanations, and vector similarity. ## API Layers & Credit Metering - **L1 (Raw Questions)** — 1 credit per request - **Assessment Paper / Session Assembly** — 5 credits per paper (`0` credits to reconnect to an active session) - **L2 (Metadata)** — 3 credits per request - **L3 (Explanation)** — 10 credits per request - **L4 (Intelligence)** — 10 credits per request ## Authentication All endpoints require an API key passed via the `X-API-Key` header. ## Rate Limiting Rate limits are enforced per API key based on your subscription tier (`Free` 30/min, `Developer` 120/min, `Growth` 300/min, `Scale` 500/min, `Enterprise` 1,000/min). Check `X-RateLimit-Remaining` and `X-RateLimit-Reset` response headers.
9
+
10
+ The version of the OpenAPI document: 1.0.0
11
+ Contact: api@aloc.com.ng
12
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
13
+
14
+ Do not edit the class manually.
15
+ """ # noqa: E501
16
+
17
+
18
+ __version__ = "1.0.0"
19
+
20
+ # Define package exports
21
+ __all__ = [
22
+ "AlocClient",
23
+ "AssessmentsApi",
24
+ "BenchmarksApi",
25
+ "ExplanationsApi",
26
+ "HealthApi",
27
+ "IntelligenceApi",
28
+ "MetadataApi",
29
+ "QuestionsApi",
30
+ "SubjectsApi",
31
+ "ApiResponse",
32
+ "ApiClient",
33
+ "Configuration",
34
+ "OpenApiException",
35
+ "ApiTypeError",
36
+ "ApiValueError",
37
+ "ApiKeyError",
38
+ "ApiAttributeError",
39
+ "ApiException",
40
+ "CreateAssessmentSession201Response",
41
+ "CreateAssessmentSession201ResponseData",
42
+ "CreateAssessmentSessionRequest",
43
+ "CurriculumNode",
44
+ "CursorPagination",
45
+ "Error",
46
+ "ExamSession",
47
+ "ExplainQuestion200Response",
48
+ "ExplainQuestionRequest",
49
+ "Explanation",
50
+ "ExplanationCommonMistakesInner",
51
+ "FindSimilarQuestions200Response",
52
+ "FindSimilarQuestions200ResponseDataInner",
53
+ "GenerateAssessment200Response",
54
+ "GenerateAssessment200ResponseData",
55
+ "GenerateAssessment200ResponseDataDifficultyBreakdown",
56
+ "GenerateAssessmentRequest",
57
+ "GenerateAssessmentRequestDifficultyDistribution",
58
+ "GetAssessmentSessionQuestions200Response",
59
+ "GetBenchmarkSampleQuestions200Response",
60
+ "GetBenchmarkSampleQuestions200ResponseData",
61
+ "GetBenchmarkSubjects200Response",
62
+ "GetBenchmarkSubjects200ResponseDataInner",
63
+ "GetCurriculum200Response",
64
+ "GetExamTrends200Response",
65
+ "GetPublicMetrics200Response",
66
+ "GetPublicMetrics200ResponseData",
67
+ "GetQuestion200Response",
68
+ "GetSubject200Response",
69
+ "GetSubjectsCallCounts200Response",
70
+ "GetSubjectsCallCounts200ResponseDataInner",
71
+ "GetTopicBenchmarks200Response",
72
+ "GetTopicBenchmarks200ResponseData",
73
+ "GetTopicBenchmarks200ResponseDataDifficultyDistribution",
74
+ "GetTopicBenchmarks200ResponseDataTopicsInner",
75
+ "GetTopicBenchmarks200ResponseDataTopicsInnerDifficultyDistribution",
76
+ "GetTopicBenchmarks200ResponseDataTopicsInnerYearBreakdownInner",
77
+ "GetTopicBenchmarks200ResponseDataYearRange",
78
+ "HealthCheck200Response",
79
+ "ListQuestions200Response",
80
+ "ListSubjects200Response",
81
+ "ListSubjectsForYear200Response",
82
+ "ListSubjectsForYear200ResponseDataInner",
83
+ "ListTopics200Response",
84
+ "ListYearsForSubject200Response",
85
+ "ListYearsForSubject200ResponseDataInner",
86
+ "Metadata",
87
+ "Question",
88
+ "QuestionOptions",
89
+ "QuestionProvenance",
90
+ "QuestionWithMetadata",
91
+ "ReportQuestion201Response",
92
+ "ReportQuestion201ResponseData",
93
+ "ReportQuestionRequest",
94
+ "ResponseMeta",
95
+ "Subject",
96
+ "SubjectDetail",
97
+ "SubjectFeatures",
98
+ "SubjectYearRange",
99
+ "Topic",
100
+ "TopicSubtopicsInner",
101
+ "TrendAnalysis",
102
+ "TrendAnalysisDifficultyTrendInner",
103
+ "TrendAnalysisMostTestedTopicsInner",
104
+ "TrendAnalysisYearRange",
105
+ ]
106
+
107
+ # import apis into sdk package
108
+ from aloc_sdk.api.assessments_api import AssessmentsApi as AssessmentsApi
109
+ from aloc_sdk.api.benchmarks_api import BenchmarksApi as BenchmarksApi
110
+ from aloc_sdk.api.explanations_api import ExplanationsApi as ExplanationsApi
111
+ from aloc_sdk.api.health_api import HealthApi as HealthApi
112
+ from aloc_sdk.api.intelligence_api import IntelligenceApi as IntelligenceApi
113
+ from aloc_sdk.api.metadata_api import MetadataApi as MetadataApi
114
+ from aloc_sdk.api.questions_api import QuestionsApi as QuestionsApi
115
+ from aloc_sdk.api.subjects_api import SubjectsApi as SubjectsApi
116
+
117
+ # import ApiClient
118
+ from aloc_sdk.api_response import ApiResponse as ApiResponse
119
+ from aloc_sdk.api_client import ApiClient as ApiClient
120
+ from aloc_sdk.configuration import Configuration as Configuration
121
+ from aloc_sdk.exceptions import OpenApiException as OpenApiException
122
+ from aloc_sdk.exceptions import ApiTypeError as ApiTypeError
123
+ from aloc_sdk.exceptions import ApiValueError as ApiValueError
124
+ from aloc_sdk.exceptions import ApiKeyError as ApiKeyError
125
+ from aloc_sdk.exceptions import ApiAttributeError as ApiAttributeError
126
+ from aloc_sdk.exceptions import ApiException as ApiException
127
+
128
+ # import models into sdk package
129
+ from aloc_sdk.models.create_assessment_session201_response import CreateAssessmentSession201Response as CreateAssessmentSession201Response
130
+ from aloc_sdk.models.create_assessment_session201_response_data import CreateAssessmentSession201ResponseData as CreateAssessmentSession201ResponseData
131
+ from aloc_sdk.models.create_assessment_session_request import CreateAssessmentSessionRequest as CreateAssessmentSessionRequest
132
+ from aloc_sdk.models.curriculum_node import CurriculumNode as CurriculumNode
133
+ from aloc_sdk.models.cursor_pagination import CursorPagination as CursorPagination
134
+ from aloc_sdk.models.error import Error as Error
135
+ from aloc_sdk.models.exam_session import ExamSession as ExamSession
136
+ from aloc_sdk.models.explain_question200_response import ExplainQuestion200Response as ExplainQuestion200Response
137
+ from aloc_sdk.models.explain_question_request import ExplainQuestionRequest as ExplainQuestionRequest
138
+ from aloc_sdk.models.explanation import Explanation as Explanation
139
+ from aloc_sdk.models.explanation_common_mistakes_inner import ExplanationCommonMistakesInner as ExplanationCommonMistakesInner
140
+ from aloc_sdk.models.find_similar_questions200_response import FindSimilarQuestions200Response as FindSimilarQuestions200Response
141
+ from aloc_sdk.models.find_similar_questions200_response_data_inner import FindSimilarQuestions200ResponseDataInner as FindSimilarQuestions200ResponseDataInner
142
+ from aloc_sdk.models.generate_assessment200_response import GenerateAssessment200Response as GenerateAssessment200Response
143
+ from aloc_sdk.models.generate_assessment200_response_data import GenerateAssessment200ResponseData as GenerateAssessment200ResponseData
144
+ from aloc_sdk.models.generate_assessment200_response_data_difficulty_breakdown import GenerateAssessment200ResponseDataDifficultyBreakdown as GenerateAssessment200ResponseDataDifficultyBreakdown
145
+ from aloc_sdk.models.generate_assessment_request import GenerateAssessmentRequest as GenerateAssessmentRequest
146
+ from aloc_sdk.models.generate_assessment_request_difficulty_distribution import GenerateAssessmentRequestDifficultyDistribution as GenerateAssessmentRequestDifficultyDistribution
147
+ from aloc_sdk.models.get_assessment_session_questions200_response import GetAssessmentSessionQuestions200Response as GetAssessmentSessionQuestions200Response
148
+ from aloc_sdk.models.get_benchmark_sample_questions200_response import GetBenchmarkSampleQuestions200Response as GetBenchmarkSampleQuestions200Response
149
+ from aloc_sdk.models.get_benchmark_sample_questions200_response_data import GetBenchmarkSampleQuestions200ResponseData as GetBenchmarkSampleQuestions200ResponseData
150
+ from aloc_sdk.models.get_benchmark_subjects200_response import GetBenchmarkSubjects200Response as GetBenchmarkSubjects200Response
151
+ from aloc_sdk.models.get_benchmark_subjects200_response_data_inner import GetBenchmarkSubjects200ResponseDataInner as GetBenchmarkSubjects200ResponseDataInner
152
+ from aloc_sdk.models.get_curriculum200_response import GetCurriculum200Response as GetCurriculum200Response
153
+ from aloc_sdk.models.get_exam_trends200_response import GetExamTrends200Response as GetExamTrends200Response
154
+ from aloc_sdk.models.get_public_metrics200_response import GetPublicMetrics200Response as GetPublicMetrics200Response
155
+ from aloc_sdk.models.get_public_metrics200_response_data import GetPublicMetrics200ResponseData as GetPublicMetrics200ResponseData
156
+ from aloc_sdk.models.get_question200_response import GetQuestion200Response as GetQuestion200Response
157
+ from aloc_sdk.models.get_subject200_response import GetSubject200Response as GetSubject200Response
158
+ from aloc_sdk.models.get_subjects_call_counts200_response import GetSubjectsCallCounts200Response as GetSubjectsCallCounts200Response
159
+ from aloc_sdk.models.get_subjects_call_counts200_response_data_inner import GetSubjectsCallCounts200ResponseDataInner as GetSubjectsCallCounts200ResponseDataInner
160
+ from aloc_sdk.models.get_topic_benchmarks200_response import GetTopicBenchmarks200Response as GetTopicBenchmarks200Response
161
+ from aloc_sdk.models.get_topic_benchmarks200_response_data import GetTopicBenchmarks200ResponseData as GetTopicBenchmarks200ResponseData
162
+ from aloc_sdk.models.get_topic_benchmarks200_response_data_difficulty_distribution import GetTopicBenchmarks200ResponseDataDifficultyDistribution as GetTopicBenchmarks200ResponseDataDifficultyDistribution
163
+ from aloc_sdk.models.get_topic_benchmarks200_response_data_topics_inner import GetTopicBenchmarks200ResponseDataTopicsInner as GetTopicBenchmarks200ResponseDataTopicsInner
164
+ from aloc_sdk.models.get_topic_benchmarks200_response_data_topics_inner_difficulty_distribution import GetTopicBenchmarks200ResponseDataTopicsInnerDifficultyDistribution as GetTopicBenchmarks200ResponseDataTopicsInnerDifficultyDistribution
165
+ from aloc_sdk.models.get_topic_benchmarks200_response_data_topics_inner_year_breakdown_inner import GetTopicBenchmarks200ResponseDataTopicsInnerYearBreakdownInner as GetTopicBenchmarks200ResponseDataTopicsInnerYearBreakdownInner
166
+ from aloc_sdk.models.get_topic_benchmarks200_response_data_year_range import GetTopicBenchmarks200ResponseDataYearRange as GetTopicBenchmarks200ResponseDataYearRange
167
+ from aloc_sdk.models.health_check200_response import HealthCheck200Response as HealthCheck200Response
168
+ from aloc_sdk.models.list_questions200_response import ListQuestions200Response as ListQuestions200Response
169
+ from aloc_sdk.models.list_subjects200_response import ListSubjects200Response as ListSubjects200Response
170
+ from aloc_sdk.models.list_subjects_for_year200_response import ListSubjectsForYear200Response as ListSubjectsForYear200Response
171
+ from aloc_sdk.models.list_subjects_for_year200_response_data_inner import ListSubjectsForYear200ResponseDataInner as ListSubjectsForYear200ResponseDataInner
172
+ from aloc_sdk.models.list_topics200_response import ListTopics200Response as ListTopics200Response
173
+ from aloc_sdk.models.list_years_for_subject200_response import ListYearsForSubject200Response as ListYearsForSubject200Response
174
+ from aloc_sdk.models.list_years_for_subject200_response_data_inner import ListYearsForSubject200ResponseDataInner as ListYearsForSubject200ResponseDataInner
175
+ from aloc_sdk.models.metadata import Metadata as Metadata
176
+ from aloc_sdk.models.question import Question as Question
177
+ from aloc_sdk.models.question_options import QuestionOptions as QuestionOptions
178
+ from aloc_sdk.models.question_provenance import QuestionProvenance as QuestionProvenance
179
+ from aloc_sdk.models.question_with_metadata import QuestionWithMetadata as QuestionWithMetadata
180
+ from aloc_sdk.models.report_question201_response import ReportQuestion201Response as ReportQuestion201Response
181
+ from aloc_sdk.models.report_question201_response_data import ReportQuestion201ResponseData as ReportQuestion201ResponseData
182
+ from aloc_sdk.models.report_question_request import ReportQuestionRequest as ReportQuestionRequest
183
+ from aloc_sdk.models.response_meta import ResponseMeta as ResponseMeta
184
+ from aloc_sdk.models.subject import Subject as Subject
185
+ from aloc_sdk.models.subject_detail import SubjectDetail as SubjectDetail
186
+ from aloc_sdk.models.subject_features import SubjectFeatures as SubjectFeatures
187
+ from aloc_sdk.models.subject_year_range import SubjectYearRange as SubjectYearRange
188
+ from aloc_sdk.models.topic import Topic as Topic
189
+ from aloc_sdk.models.topic_subtopics_inner import TopicSubtopicsInner as TopicSubtopicsInner
190
+ from aloc_sdk.models.trend_analysis import TrendAnalysis as TrendAnalysis
191
+ from aloc_sdk.models.trend_analysis_difficulty_trend_inner import TrendAnalysisDifficultyTrendInner as TrendAnalysisDifficultyTrendInner
192
+ from aloc_sdk.models.trend_analysis_most_tested_topics_inner import TrendAnalysisMostTestedTopicsInner as TrendAnalysisMostTestedTopicsInner
193
+ from aloc_sdk.models.trend_analysis_year_range import TrendAnalysisYearRange as TrendAnalysisYearRange
194
+
195
+
196
+
197
+ import os as _os
198
+ from typing import Optional as _Optional
199
+
200
+
201
+ class AlocClient:
202
+ """Ergonomic client facade for the ALOC Assessment Content Infrastructure API.
203
+
204
+ Example:
205
+ from aloc_sdk import AlocClient
206
+
207
+ client = AlocClient(api_key="aloc_live_...") # or set ALOC_API_KEY env var
208
+ res = client.questions.list_questions(subject="mathematics", exam_type="jamb", year=2022)
209
+ """
210
+
211
+ def __init__(self, api_key: _Optional[str] = None, host: _Optional[str] = None) -> None:
212
+ resolved_key = api_key if api_key is not None else _os.environ.get("ALOC_API_KEY", "")
213
+ self.configuration = Configuration(host=host) if host else Configuration()
214
+ if resolved_key:
215
+ self.configuration.api_key["apiKeyAuth"] = resolved_key
216
+ self.api_client = ApiClient(self.configuration)
217
+ self.questions = QuestionsApi(self.api_client)
218
+ self.assessments = AssessmentsApi(self.api_client)
219
+ self.explanations = ExplanationsApi(self.api_client)
220
+ self.intelligence = IntelligenceApi(self.api_client)
221
+ self.metadata = MetadataApi(self.api_client)
222
+ self.subjects = SubjectsApi(self.api_client)
223
+ self.benchmarks = BenchmarksApi(self.api_client)
224
+ self.health = HealthApi(self.api_client)
225
+
226
+ def close(self) -> None:
227
+ if hasattr(self.api_client, "close"):
228
+ self.api_client.close()
229
+
230
+ def __enter__(self) -> "AlocClient":
231
+ return self
232
+
233
+ def __exit__(self, exc_type: object, exc_val: object, exc_tb: object) -> None:
234
+ self.close()
@@ -0,0 +1,12 @@
1
+ # flake8: noqa
2
+
3
+ # import apis into api package
4
+ from aloc_sdk.api.assessments_api import AssessmentsApi
5
+ from aloc_sdk.api.benchmarks_api import BenchmarksApi
6
+ from aloc_sdk.api.explanations_api import ExplanationsApi
7
+ from aloc_sdk.api.health_api import HealthApi
8
+ from aloc_sdk.api.intelligence_api import IntelligenceApi
9
+ from aloc_sdk.api.metadata_api import MetadataApi
10
+ from aloc_sdk.api.questions_api import QuestionsApi
11
+ from aloc_sdk.api.subjects_api import SubjectsApi
12
+