#api-bindings #http-client #eskom-se-push #eskom #se-push

eskom_se_push-api

API Bindings to the Eskom-se-Push API

2 unstable releases

0.2.0 Feb 18, 2023
0.1.0 Feb 4, 2023

#394 in #http-client

MIT/Apache

46KB
865 lines

EskomSePush API

This Rust library is an unofficial library to the EskomSePush API

TODO

  • Improve docs
  • Add enum types where relevant
  • Improve error types
  • Add examples
  • Allow option for getting API key from environment variables
  • Features to control sync and async functionality
  • Add unit tests
  • Improve status struct to allow for more flexible structure for future proofing (Towns/cities with different loadshedding schedule might be added in the future)
  • Add helper functions
  • Restucture code based on this article by Gitlab crate maintainers Designing Rust bindings for REST APIs

Breaking Changes

  • You can now just build the URL without using one of the preconfigured http clients and use your preferred one instead
  • The preconfigured clients are now all locked behind features
  • A ureq client has been added but requires the ureq feature to be enabled
  • There are response handlers available for both ureq and reqwest http clients
  • There are builders for each URL endpoint so you just need to use what you need

Examples

You can view the examples here

Contributions

Contributions and PR's are welcome.

Dependencies

~6–18MB
~252K SLoC