Monthly Venmo

monthly-venmo

A Python script to automate monthly Venmo requests
Explore the docs »

View Demo · Report Bug · Ask a Question

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
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
• pip
• GitHub Actions
• Venmo
• Telegram

Getting Started

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

Prerequisites

• Python >= v3
• pip

Installation

1. Clone the repo

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

2. Install pip packages

   pip install -r requirements.txt

3. Copy the .env.example to .env and add environment variables
4. Run the health script to verify setup:

   python3 health.py

5. Run the main script:

   python3 init.py

Updating the requirements.txt

1. Run this command

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 for more information.

Contact

Joe Previte - @jsjoeio

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

Acknowledgements

• @mmohades for the Venmo library
• @liiight for the notifiers library
• @othneildrew for the README template