Giter VIP home page Giter VIP logo

eskomsepush's Introduction

EskomSePush

Description

Python wrapper for the EskomSePush API to get the Eskom Loadshedding schedule for your area

Disclaimer

I am a beginner programmer and this is my first code commit. If you have better ways of coding it or find bugs in my code, please feel free to fix :)

Functions

  • get_status() get the National loadshedding schedule
  • get_allowance() check your credits
  • search_areas() search area using text search
  • get_area_information get the area information based on the area_id (use search_areas() to get the area_id
  • get_area_information_test for testing purposes. Does not count towards your credits
  • get_areas_nearby search for areas nearby (longitude and latitude as input)
  • get_topics_nearby find topics created by users nearby (longitude and latitude as input)

version 1.1 (work in progress)

  • Add logging

Additional notes

  • Remember to obtain your API_KEY by regisering
  • Put your API_KEY in a .env file
  • Add BASE_URL = "https://developer.sepush.co.za/business/2.0" in the .env file
  • Install all the dependencies from the requirements.txt file
  • Create app.py (mine is ignored in the .gitignore file) to create an object of the class EskomSePush

Resources

EskomSePush API documentation

eskomsepush's People

Contributors

krispyren avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

cathbert

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.