eskom_se_push-api

Crates.ioeskom_se_push-api
lib.rseskom_se_push-api
version0.2.0
sourcesrc
created_at2023-02-04 12:32:22.575008
updated_at2023-02-18 09:14:27.870013
descriptionAPI Bindings to the Eskom-se-Push API
homepagehttps://github.com/ZimboPro/eskom-se-push-api
repositoryhttps://github.com/ZimboPro/eskom-se-push-api
max_upload_size
id776335
size98,136
Leslie de Jager (ZimboPro)

documentation

README

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.

Commit count: 40

cargo fmt