https://github.com/spifory/shedding.py
An API wrapper for EskomSePush.
https://github.com/spifory/shedding.py
eskom eskomsepush loadshedding python3 south-africa
Last synced: about 1 month ago
JSON representation
An API wrapper for EskomSePush.
- Host: GitHub
- URL: https://github.com/spifory/shedding.py
- Owner: spifory
- License: mit
- Created: 2023-04-25T11:12:43.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-24T18:40:21.000Z (8 months ago)
- Last Synced: 2025-04-14T18:13:33.777Z (about 1 month ago)
- Topics: eskom, eskomsepush, loadshedding, python3, south-africa
- Language: Python
- Homepage: https://sheddingpy.rtfd.io
- Size: 66.4 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# shedding.py
Shedding.py is a Python wrapper for the EskomSePush API. It provides a simple interface to the API, and handles all the authentication and session management for you.
## Example
Here is a basic example of us getting an area's information
```py
from shedding import get_area_information
area = get_area_information(
authorization_token="api.token",
id="eskde-10-fourwaysext10cityofjohannesburggauteng"
)
print(area) # returns all area information from the City of Johannesburg
print(area["schedule"]["days"]) # returns a list of schedules for each day
```
## Installation
```sh
# Windows
$ py -m pip install shedding.py
# UNIX Systems (Linux/MacOS)
$ python3 -m pip install shedding.py
```
## Links
- [Documentation](https://sheddingpy.rtfd.io)
- [Discord Support Server](https://discord.gg/VTPzbjRFpF)
- [EskomSePush API Documentation](https://documenter.getpostman.com/view/1296288/UzQuNk3E)