Metadata-Version: 2.3
Name: shakepy
Version: 0.1.0
Summary: A Shakepay API Interface for Python 
Author: quizque
Author-email: quizque <13785390+quizque@users.noreply.github.com>
Requires-Python: >=3.14
Description-Content-Type: text/markdown

# Shakepay Python Interface
## _Fully functional replacement for the app_


The module is designed to be as simple and flexible as possible, so most functions return raw values. All functions have DOCSTRING if you are confused on what they do, but most function are pretty self explanatory.

If you are interested in creating your own auth system instead of using the quick_auth function, look inside `shakepay_api/test.py` and `shakepay_api/authentication.py` for more information on how you should handle interaction.

## Examples

- `example_trigger_shackingsats.py` - authenticates the user and retrieves the shacking sats rewards
- `example_get_authentication.py` - authenticates the user and retrieves wallet information
- `example_send_cad.py` - authenticates the user and attempts to send 1$

The API will eventually be fully documented but I tried to make it as human friendly as possible if you do a little digging inside the files and look at the examples.

## Improvements

Feel free to create an issue if you believe an improvement could be made!

## Donate
You can tip me on Shakepay `@hammy5030`, BTC `3JjR1QbZ7zB9k744ruegMVxqm1hZ16W5U8`, ETH `0xa877184aeaacc53d06eea81ebbc5feb0ee47cd76`, or NANO `nano_1o5wnzinh6r9t5c63hzf3rf33x4bir8cpfuerxcyt8zwg9f5nhjtk46gja3s`
