bobokun/actualtap-py repository overview

⁠ActualTap-Py

Heavily inspired by Actual Tap⁠ but written in python using Actualpy⁠ and a added a few enhancements.
Special thanks to @MattFaz⁠ for the initial Actual Tap work!
Automatically create transactions in Actual Budget⁠ when you use Tap-to-Pay on a mobile device

⁠Contents

• Overview⁠
• Run the App⁠

⁠Overview

Actual Tap uses FastAPI that utilises the Actualpy⁠ to create transactions.

The primary purpose of Actual Tap is receive a POST request from mobile devices (.e.g iOS Shortcuts) when a Tap to Pay transaction is made. Once the POST request is received Actual Tap will POST the Name and Amount to Actual Budget.

In addition, there is a configuration file⁠ that allows you to map between the Tap to Pay account and your Actual Account ID.

Ideal flow:

1. Mobile device is tapped to make a purchase
2. Automation on mobile device is triggered
   • Recommended apps are Shortcuts⁠ (iOS) or Tasker⁠ (Android)
3. POST request containing transaction information (merchant, amount, and card) is sent to Actual Tap
4. Actual Tap creates the transaction in Actual Budget

Notes: This is in active / heavy development, issues, pull requests, feature requests etc. are welcome.

---

⁠Running the App

To run Actual Tap locally (i.e. for development or not containerised):

• $ cp config/config.yml.sample config/config.yml
• Edit the config.yml file accordingly

To run Actual Tap in docker ensure you edit variables in the docker-compose.yml file.

• Note: You will also need to update the volumes path

The app will be running on port 8000