| Name | powerschoolapi-cars1n JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | |
| Summary | A small package to interact with powerschool's api |
| upload_time | 2023-12-11 07:24:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2018 The Python Packaging Authority 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. |
| keywords |
api
powerschool
powerschoolapi
powerschoolapi_cars1n
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# PowerSchool API Python Package
This Python package provides an easy-to-use interface for interacting with the PowerSchool API, allowing users to perform various operations such as retrieving student counts, student details, course counts, and more from a PowerSchool server.
## Features
- Get student count for a specified school.
- Retrieve detailed student information.
## Installation
To install the PowerSchool API package, use pip:
```bash
pip install powerschool-api-cars1n
```
## Usage
Here's a quick start on how to use the PowerSchool API package:
```bash
from powerschoolapi_cars1n import PS
# Initialize the PowerSchool API client
ps = PS()
# Get the count of students in a school
student_count = ps.get_student_count("school_dcid")
print("Student Count:", student_count)
# Get detailed information about a student
student_info = ps.get_student("student_id")
print("Student Information:", student_info)
```
## Configuration
Before using the PowerSchool API, ensure that you have set up the necessary environment variables. Your .env file should look something like this.
```bash
CLIENT_ID =
CLIENT_SECRET =
POWERSCHOOL_SERVER_URL = "https://powerschool.example.com:443"
```
## Contributing
Contributions to the PowerSchool API package are welcome. Please follow these steps to contribute:
- Fork the repository.
- Create a new branch for your feature.
- Add your changes.
- Submit a pull request.
## License
This project is licensed under the MIT License.
## Contact
For any queries or issues, please open an issue on the GitHub repository or contact me via email at 14williamsc@gmail.com
### Semi-working features
If you have a powerschool plugin then the normal queries_root folder that is required can be taken into account when making calls to those user created endpoints.
Here is how you would set it up.
```bash
from AccessToken import AccessToken
import os
# Create an AccessToken instance and get the access token
token_instance = AccessToken()
access_token = token_instance.get_access_token()
queries_root_path = os.path.join(os.getcwd(), "queries_root")
data_access = DataAccess(access_token, school_dcid="1234", base_url=base_url, queries_root_path=queries_root_path, xml_file_name="the file name that is in your queries root folder")
# User created path com.organization.attendance_manager.attendance.get_schwifty
response = data_access.fetch_data("attendance.get_schwifty", params={
"date": "01/01/1999",
"schoolid": "1234",
}, method="POST")
ic(response)
```
Raw data
{
"_id": null,
"home_page": "",
"name": "powerschoolapi-cars1n",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "api,powerschool,powerschoolapi,powerschoolapi_cars1n",
"author": "",
"author_email": "Carson Williams <14williamsc@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/3d/c2/a28ae728d86adef1846738eb5e370d76e5fc2b725612462916e5cf263282/powerschoolapi_cars1n-1.0.4.tar.gz",
"platform": null,
"description": "# PowerSchool API Python Package\n\nThis Python package provides an easy-to-use interface for interacting with the PowerSchool API, allowing users to perform various operations such as retrieving student counts, student details, course counts, and more from a PowerSchool server.\n\n## Features\n\n- Get student count for a specified school.\n- Retrieve detailed student information.\n\n## Installation\n\nTo install the PowerSchool API package, use pip:\n\n```bash\npip install powerschool-api-cars1n\n```\n\n## Usage\n\nHere's a quick start on how to use the PowerSchool API package:\n\n```bash\nfrom powerschoolapi_cars1n import PS\n\n# Initialize the PowerSchool API client\nps = PS()\n\n# Get the count of students in a school\nstudent_count = ps.get_student_count(\"school_dcid\")\nprint(\"Student Count:\", student_count)\n\n# Get detailed information about a student\nstudent_info = ps.get_student(\"student_id\")\nprint(\"Student Information:\", student_info)\n\n```\n\n## Configuration\n\nBefore using the PowerSchool API, ensure that you have set up the necessary environment variables. Your .env file should look something like this.\n\n```bash\nCLIENT_ID =\nCLIENT_SECRET =\nPOWERSCHOOL_SERVER_URL = \"https://powerschool.example.com:443\"\n```\n\n## Contributing\n\nContributions to the PowerSchool API package are welcome. Please follow these steps to contribute:\n\n - Fork the repository.\n - Create a new branch for your feature.\n - Add your changes.\n - Submit a pull request.\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contact\n\nFor any queries or issues, please open an issue on the GitHub repository or contact me via email at 14williamsc@gmail.com\n\n\n### Semi-working features\nIf you have a powerschool plugin then the normal queries_root folder that is required can be taken into account when making calls to those user created endpoints.\n\nHere is how you would set it up.\n\n```bash\n from AccessToken import AccessToken\n import os\n# Create an AccessToken instance and get the access token\n token_instance = AccessToken()\n access_token = token_instance.get_access_token()\n\n queries_root_path = os.path.join(os.getcwd(), \"queries_root\")\n\n data_access = DataAccess(access_token, school_dcid=\"1234\", base_url=base_url, queries_root_path=queries_root_path, xml_file_name=\"the file name that is in your queries root folder\")\n# User created path com.organization.attendance_manager.attendance.get_schwifty\n response = data_access.fetch_data(\"attendance.get_schwifty\", params={\n \"date\": \"01/01/1999\",\n \"schoolid\": \"1234\",\n }, method=\"POST\")\n\n ic(response)\n```\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 The Python Packaging Authority 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.",
"summary": "A small package to interact with powerschool's api",
"version": "1.0.4",
"project_urls": {
"Homepage": "https://github.com/cars1n/powerschoolapi"
},
"split_keywords": [
"api",
"powerschool",
"powerschoolapi",
"powerschoolapi_cars1n"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86f93446421e53041b589943387dfc4c9ce502786a1d8ae2c2bb336c82c101cf",
"md5": "036af1b22a82205545f2f5a8493e5023",
"sha256": "94c8dfd69a312d8075dd9f97b2338854d652878a11f663e13858481249dc9bba"
},
"downloads": -1,
"filename": "powerschoolapi_cars1n-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "036af1b22a82205545f2f5a8493e5023",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7960,
"upload_time": "2023-12-11T07:24:18",
"upload_time_iso_8601": "2023-12-11T07:24:18.731659Z",
"url": "https://files.pythonhosted.org/packages/86/f9/3446421e53041b589943387dfc4c9ce502786a1d8ae2c2bb336c82c101cf/powerschoolapi_cars1n-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3dc2a28ae728d86adef1846738eb5e370d76e5fc2b725612462916e5cf263282",
"md5": "450c1de38326649b2ddeb0d6d8d0b0f8",
"sha256": "637dfbf588e9172d7366066d8569efc457385aa0382a1b3ee073b6b980e4ba03"
},
"downloads": -1,
"filename": "powerschoolapi_cars1n-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "450c1de38326649b2ddeb0d6d8d0b0f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7432992,
"upload_time": "2023-12-11T07:24:33",
"upload_time_iso_8601": "2023-12-11T07:24:33.319118Z",
"url": "https://files.pythonhosted.org/packages/3d/c2/a28ae728d86adef1846738eb5e370d76e5fc2b725612462916e5cf263282/powerschoolapi_cars1n-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-11 07:24:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cars1n",
"github_project": "powerschoolapi",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "powerschoolapi-cars1n"
}
