Aeripy
Aeripy is a Python adapter for the Aeries Student Information System API. It’s goal is to simplify interaction with your district’s Aeries database.
This library is mostly a wrapper for the popular requests library.
Note: Aeripy is in no way affiliated with Aeries Software, Inc. This module is based on their publicly available documentation.
Installation
Aeripy is supported on Python 3.8+. The recommended way to install Aeripy is via pip.
pip install aeripyQuickstart
The following example uses the Aeries demo database URL and API key. Both are found in their documentation.
To use this module with your own Aeries database, you will need your district’s URL and API key. See the URL and API Key section for details.
# Aeries Demo URL and API key
hostname = 'demo.aeries.net/aeries/api/'
api_key = '477abe9e7d27439681d62f4e0de1f5e1'
# In production the URL and API key should not be hardcoded.
# For example, they can be retrieved from an environment variable
hostname = os.getenv('AERIES_URL')
api_key = os.getenv('API_KEY')Create an Aeripy instance and use that to interact with the API.
from aeripy import Aeripy
aeries = Aeripy(hostname=hostname, api_key=api_key)
# Get all staff
staff_list = aeries.get_staff()
# Print the last name of the 55th staff member
print(staff_list[55].last_Name)
# Output:
# Barrows
# Print the first name of the 55th staff member
print(staff_list[55].last_Name)
# Output:
# James
# Print the ID of the 55th staff member
print(staff_list[55].id)
# Output:
# 994748Check out the full documentation for a list of currently supported methods and more examples.
URL and API Key
You must have access to the Security section in Aeries Web to obtain or create the API key.
1 maintainer
Metadata
1 maintainer
Release files for aeripy 0.2.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| aeripy-0.2.16.tar.gz | 8.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aeripy-0.2.16-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.4 kB
Release files / aeripy-0.2.16.tar.gz
| Download URL | aeripy-0.2.16.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6bf32b94741bb9ae1440ecbd25d1e46008b84c4320f9d0fc3b2a27ba886ed54
|
|
BLAKE2b-256 checksum How to use checksums |
8e9475626c9db13fab4cc85bd0f87894010046345f694f6efe9167caef7fdb65
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Release files / aeripy-0.2.16-py3-none-any.whl
| Download URL | aeripy-0.2.16-py3-none-any.whl |
|---|---|
| Size | 9.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f736a0a354f6dd5d6ead074630c39404d496d0195cafdbcd95656a2d869a523d
|
|
BLAKE2b-256 checksum How to use checksums |
240ab8609f88c4cbca3d7b27c77c2de15524c7e83584e6bf34916473def31102
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.1
|
Security for aeripy 0.2.16
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
