ripple-energy 2.0.0

Python Module For Ripple Energy

Ripple Energy

---

Table of Contents

• Known Bugs And Issues
• To-Do
• Installation
• Example
• License

Known Bugs And Issues

• Any (all?) GraphQL query functions fail solved by dapalex/py-graphql-mapper#25
• list_Date type clash warning solved by dapalex/py-graphql-mapper#25
• Unsure of header format for token auth now confirmed working
• insightsChartData optional in response but mandatory in framework

To-Do

• Complete function wrappers for all GraphQL queries
• Complete function wrappers for all GraphQL mutations
• Create function exceptions
• Put functions into classes
• Add linting
• Create tests
• Create build pipeline
• Publish to PyPi
• Make Async?

Installation

At present, this package has not been published to PyPi - You will therefore need to clone this repository to use it.

git clone https://github.com/danieledwardgeorgehitchcock/ripple-energy.git

This project leverages the use of Hatch for project management - please follow the installation instructions there before continuing.

Once the above has completed, enter in to the project directory

cd ripple-energy

As this package is managed by Hatch, you can start an environment which automatically pulls the project dependencies

hatch shell start

You should then be able to use the package from within this environment.

Example

Me:

from  ripple_energy  import RippleEnergy

ripple  = RippleEnergy(email  =  "YOUR_RIPPLE_EMAIL", password  =  "YOUR_RIPPLE_PASSWORD")

data = ripple.me()

print(data)

License

ripple-energy is distributed under the terms of the MIT license.