An open API service indexing awesome lists of open source software.

https://github.com/jsjoeio/monthly-venmo

A Python script to automate monthly Venmo requests
https://github.com/jsjoeio/monthly-venmo

python telegram-bot venmo-api

Last synced: 7 months ago
JSON representation

A Python script to automate monthly Venmo requests

Awesome Lists containing this project

README

          

# Monthly Venmo





Logo

monthly-venmo


A Python script to automate monthly Venmo requests


Explore the docs »




View Demo
·
Report Bug
·
Ask a Question

[![ui.dev newsletter - your weekly dose of JS](/images/dose-16x1.jpg)](https://bytes.dev/?r=jsjoeio)
Support the project by signing up for the UI.dev newsletter using [our link](https://bytes.dev/?r=jsjoeio)!

Table of Contents




  1. About The Project



  2. Getting Started


  3. License

  4. Contact

  5. Acknowledgements

## About The Project




This is a Python script which runs once a month and sends Venmo requests. And it notifies you via Telegram when the requests were sent.

There is also a second script — `health.py` — which runs once a week on Sundays to ensure everything is working as expected.

### Built With

- [Python](https://www.python.org/downloads/)
- [pip](https://pip.pypa.io/en/stable/installing/)
- [GitHub Actions](https://docs.github.com/en/actions)
- [Venmo](https://venmo.com/signup/)
- [Telegram](https://telegram.org/)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

- Python >= v3
- `pip`

### Installation

1. Clone the repo
```sh
git clone https://github.com/jsjoeio/monthly-venmo.git
```
2. Install pip packages
```sh
pip install -r requirements.txt
```
3. Copy the `.env.example` to `.env` and add environment variables
4. Run the health script to verify setup:
```sh
python3 health.py
```
5. Run the main script:
```sh
python3 init.py
```

### Updating the `requirements.txt`

1. Run this command

```shell
pip3 freeze > requirements.txt
```

2. delete all the nonesense (aka leave only the actual modules used in the script)

## License

Distributed under the GPL-3.0 License. See [`LICENSE`](./LICENSE) for more information.

## Contact

Joe Previte - [@jsjoeio](https://twitter.com/jsjoeio)

Project Link: [https://github.com/jsjoeio/monthly-venmo](https://github.com/jsjoeio/monthly-venmo)

## Acknowledgements

- [@mmohades for the Venmo library](https://github.com/mmohades/Venmo)
- [@liiight for the notifiers library](https://github.com/liiight/notifiers)
- [@othneildrew for the README template](https://github.com/othneildrew/Best-README-Template)