schooldigger 1.0.0__tar.gz

schooldigger-1.0.0/LICENSE

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

schooldigger-1.0.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: schooldigger
+Version: 1.0.0
+Summary: Official Python SDK for the SchoolDigger K-12 School Data API
+Author-email: SchoolDigger / Claarware LLC <api@schooldigger.com>
+License: MIT
+Project-URL: Homepage, https://developer.schooldigger.com
+Project-URL: Repository, https://github.com/SchoolDigger/schooldigger-python
+Project-URL: Documentation, https://developer.schooldigger.com/docs
+Keywords: schooldigger,schools,education,k-12,api,school data,school rankings,education data
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Education
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3,>=1.25.3
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: license-file
+
+# SchoolDigger Python SDK
+
+Official Python client for the [SchoolDigger API](https://developer.schooldigger.com) — K-12 school data for 120,000+ U.S. schools.
+
+## Installation
+
+```bash
+pip install schooldigger
+```
+
+## Quick Start
+
+```python
+import schooldigger
+
+config = schooldigger.Configuration()
+config.api_key["appID"] = "YOUR_APP_ID"
+config.api_key["appKey"] = "YOUR_APP_KEY"
+
+client = schooldigger.ApiClient(config)
+
+# Search schools
+api = schooldigger.SchoolsApi(client)
+result = api.search_schools(st="WA", q="Lincoln")
+for school in result.school_list:
+    print(f"{school.school_name} — {school.address.city}, {school.address.state}")
+
+# Get a specific school by SchoolDigger ID
+school = api.get_school("530966001632")
+print(f"Enrollment: {school.school_yearly_details[0].number_of_students}")
+```
+
+## API Classes
+
+| Class | Methods |
+|-------|---------|
+| `SchoolsApi` | `search_schools()`, `get_school()` |
+| `DistrictsApi` | `search_districts()`, `get_district()` |
+| `RankingsApi` | `get_school_rankings()`, `get_district_rankings()` |
+| `AutocompleteApi` | `autocomplete_schools()`, `autocomplete_districts()` |
+
+## Authentication
+
+All API calls require an `appID` and `appKey`. Get your free API key at [developer.schooldigger.com](https://developer.schooldigger.com).
+
+## Documentation
+
+- [API Reference](https://developer.schooldigger.com/docs)
+- [Get your free API key](https://developer.schooldigger.com)
+- [SchoolDigger.com](https://www.schooldigger.com)
+
+## Plans
+
+| Plan | Price | Highlights |
+|------|-------|------------|
+| DEV/TEST | Free | Enterprise-level access, 20 calls/day |
+| Basic | $19.90/mo | 1 year of data |
+| Pro | $89/mo | Boundaries, geo search, finance |
+| Enterprise | $189/mo | Full depth, boundary containment |
+
+## License
+
+MIT

schooldigger-1.0.0/README.md

@@ -0,0 +1,63 @@
+# SchoolDigger Python SDK
+
+Official Python client for the [SchoolDigger API](https://developer.schooldigger.com) — K-12 school data for 120,000+ U.S. schools.
+
+## Installation
+
+```bash
+pip install schooldigger
+```
+
+## Quick Start
+
+```python
+import schooldigger
+
+config = schooldigger.Configuration()
+config.api_key["appID"] = "YOUR_APP_ID"
+config.api_key["appKey"] = "YOUR_APP_KEY"
+
+client = schooldigger.ApiClient(config)
+
+# Search schools
+api = schooldigger.SchoolsApi(client)
+result = api.search_schools(st="WA", q="Lincoln")
+for school in result.school_list:
+    print(f"{school.school_name} — {school.address.city}, {school.address.state}")
+
+# Get a specific school by SchoolDigger ID
+school = api.get_school("530966001632")
+print(f"Enrollment: {school.school_yearly_details[0].number_of_students}")
+```
+
+## API Classes
+
+| Class | Methods |
+|-------|---------|
+| `SchoolsApi` | `search_schools()`, `get_school()` |
+| `DistrictsApi` | `search_districts()`, `get_district()` |
+| `RankingsApi` | `get_school_rankings()`, `get_district_rankings()` |
+| `AutocompleteApi` | `autocomplete_schools()`, `autocomplete_districts()` |
+
+## Authentication
+
+All API calls require an `appID` and `appKey`. Get your free API key at [developer.schooldigger.com](https://developer.schooldigger.com).
+
+## Documentation
+
+- [API Reference](https://developer.schooldigger.com/docs)
+- [Get your free API key](https://developer.schooldigger.com)
+- [SchoolDigger.com](https://www.schooldigger.com)
+
+## Plans
+
+| Plan | Price | Highlights |
+|------|-------|------------|
+| DEV/TEST | Free | Enterprise-level access, 20 calls/day |
+| Basic | $19.90/mo | 1 year of data |
+| Pro | $89/mo | Boundaries, geo search, finance |
+| Enterprise | $189/mo | Full depth, boundary containment |
+
+## License
+
+MIT

schooldigger-1.0.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "schooldigger"
+version = "1.0.0"
+description = "Official Python SDK for the SchoolDigger K-12 School Data API"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    {name = "SchoolDigger / Claarware LLC", email = "api@schooldigger.com"},
+]
+keywords = [
+    "schooldigger",
+    "schools",
+    "education",
+    "k-12",
+    "api",
+    "school data",
+    "school rankings",
+    "education data",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Education",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "urllib3>=1.25.3,<3",
+    "python-dateutil>=2.8.2",
+    "pydantic>=2",
+    "typing-extensions>=4.7.1",
+]
+
+[project.urls]
+Homepage = "https://developer.schooldigger.com"
+Repository = "https://github.com/SchoolDigger/schooldigger-python"
+Documentation = "https://developer.schooldigger.com/docs"
+
+[tool.setuptools.packages.find]
+include = ["schooldigger*"]

schooldigger-1.0.0/schooldigger/__init__.py

@@ -0,0 +1,115 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    SchoolDigger API
+
+    K-12 school and district data for 120,000+ U.S. schools
+
+    The version of the OpenAPI document: v2.3
+    Contact: api@schooldigger.com
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "AutocompleteApi",
+    "DistrictsApi",
+    "RankingsApi",
+    "SchoolsApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "APIAutocompleteDistrictResult",
+    "APIAutocompleteSchoolResult23",
+    "APIBoundary12",
+    "APIChronicAbsenteeismRate",
+    "APICounty",
+    "APIDistrictAC",
+    "APIDistrictFull21",
+    "APIDistrictList21",
+    "APIDistrictListRank21",
+    "APIDistrictSum",
+    "APIDistrictSummary21",
+    "APIDropoutRate",
+    "APIGraduationRate",
+    "APILEARankHistory",
+    "APILEAYearlyDetail",
+    "APILatLong",
+    "APILocation",
+    "APIPolyline",
+    "APIRankHistory",
+    "APISchoolAC23",
+    "APISchoolFinance",
+    "APISchoolFull22",
+    "APISchoolList22",
+    "APISchoolListRank21",
+    "APISchoolReview",
+    "APISchoolSummary21",
+    "APISchoolSummary22",
+    "APITestScore",
+    "APITestScoreWrapper",
+    "APIYearlyDemographics",
+]
+
+# import apis into sdk package
+from schooldigger.api.autocomplete_api import AutocompleteApi as AutocompleteApi
+from schooldigger.api.districts_api import DistrictsApi as DistrictsApi
+from schooldigger.api.rankings_api import RankingsApi as RankingsApi
+from schooldigger.api.schools_api import SchoolsApi as SchoolsApi
+
+# import ApiClient
+from schooldigger.api_response import ApiResponse as ApiResponse
+from schooldigger.api_client import ApiClient as ApiClient
+from schooldigger.configuration import Configuration as Configuration
+from schooldigger.exceptions import OpenApiException as OpenApiException
+from schooldigger.exceptions import ApiTypeError as ApiTypeError
+from schooldigger.exceptions import ApiValueError as ApiValueError
+from schooldigger.exceptions import ApiKeyError as ApiKeyError
+from schooldigger.exceptions import ApiAttributeError as ApiAttributeError
+from schooldigger.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from schooldigger.models.api_autocomplete_district_result import APIAutocompleteDistrictResult as APIAutocompleteDistrictResult
+from schooldigger.models.api_autocomplete_school_result23 import APIAutocompleteSchoolResult23 as APIAutocompleteSchoolResult23
+from schooldigger.models.api_boundary12 import APIBoundary12 as APIBoundary12
+from schooldigger.models.api_chronic_absenteeism_rate import APIChronicAbsenteeismRate as APIChronicAbsenteeismRate
+from schooldigger.models.api_county import APICounty as APICounty
+from schooldigger.models.api_district_ac import APIDistrictAC as APIDistrictAC
+from schooldigger.models.api_district_full21 import APIDistrictFull21 as APIDistrictFull21
+from schooldigger.models.api_district_list21 import APIDistrictList21 as APIDistrictList21
+from schooldigger.models.api_district_list_rank21 import APIDistrictListRank21 as APIDistrictListRank21
+from schooldigger.models.api_district_sum import APIDistrictSum as APIDistrictSum
+from schooldigger.models.api_district_summary21 import APIDistrictSummary21 as APIDistrictSummary21
+from schooldigger.models.api_dropout_rate import APIDropoutRate as APIDropoutRate
+from schooldigger.models.api_graduation_rate import APIGraduationRate as APIGraduationRate
+from schooldigger.models.apilea_rank_history import APILEARankHistory as APILEARankHistory
+from schooldigger.models.apilea_yearly_detail import APILEAYearlyDetail as APILEAYearlyDetail
+from schooldigger.models.api_lat_long import APILatLong as APILatLong
+from schooldigger.models.api_location import APILocation as APILocation
+from schooldigger.models.api_polyline import APIPolyline as APIPolyline
+from schooldigger.models.api_rank_history import APIRankHistory as APIRankHistory
+from schooldigger.models.api_school_ac23 import APISchoolAC23 as APISchoolAC23
+from schooldigger.models.api_school_finance import APISchoolFinance as APISchoolFinance
+from schooldigger.models.api_school_full22 import APISchoolFull22 as APISchoolFull22
+from schooldigger.models.api_school_list22 import APISchoolList22 as APISchoolList22
+from schooldigger.models.api_school_list_rank21 import APISchoolListRank21 as APISchoolListRank21
+from schooldigger.models.api_school_review import APISchoolReview as APISchoolReview
+from schooldigger.models.api_school_summary21 import APISchoolSummary21 as APISchoolSummary21
+from schooldigger.models.api_school_summary22 import APISchoolSummary22 as APISchoolSummary22
+from schooldigger.models.api_test_score import APITestScore as APITestScore
+from schooldigger.models.api_test_score_wrapper import APITestScoreWrapper as APITestScoreWrapper
+from schooldigger.models.api_yearly_demographics import APIYearlyDemographics as APIYearlyDemographics
+

schooldigger-1.0.0/schooldigger/api/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+
+# import apis into api package
+from schooldigger.api.autocomplete_api import AutocompleteApi
+from schooldigger.api.districts_api import DistrictsApi
+from schooldigger.api.rankings_api import RankingsApi
+from schooldigger.api.schools_api import SchoolsApi
+