Bahi-Khata-App/Bahi-Khata

Python app to help you become prudent in your spendings

बही खाता

A Python app to help you become prudent in your spendings

View Demo · Report Bug · Request Feature

Table of Contents

• Table of Contents
• About The Project
• Supported Receipts
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Deployment
• Roadmap
• Contributing
• License
• Authors
• Acknowledgements

About The Project

Where does all my money go?

If you have been asking this question to yourself frequently, you are not alone. Handling finances can be tricky. This project is an attempt to help you plan right, so that you worry less while living from paycheck to paycheck.

Supported Receipts

• Amazon

• Flipkart

• Myntra

• Ola

• Uber

• Zomato

• Swiggy

• Curefit

Built With

• Flask
• Heroku
• Gmail API
• Beautiful Soup
• Altair
• SendGrid

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• python >=3.6
• pip
• Chrome
• ChromeDriver

Installation

1. Clone the repo

git clone https://github.com/Bahi-Khata-App/Bahi-Khata

2. Install the dependencies

pip install -r requirements.txt

3. Setup Gmail API
   1. Check gmail.readonly scope in your Gmail API OAuth consent page
   2. Add http://localhost:5000/push as redirect URI while generating credentials
   3. Download and place your Gmail API credentials in data/credentials.json
4. Place your SendGrid API credentials in data/sendgrid.json
5. (Optional) Place your analytics tracking script in base.html

Usage

1. Set flask environment variable

export FLASK_APP="gmail_flask.py"

2. Set LOCAL_DEV = True in gmail_flask.py
3. flask run
4. Complete the one time app verification

5. If any relevant data is found, you'll receive an email report similar as below

Deployment

1. Set up Heroku CLI.
2. Add redirect URI <HEROKU_APP_LINK>/push in Gmail API console.
3. Add the chromedriver and google-chrome buildpacks in app settings on your Heroku dashboard.
4. Configure environment variables for your app in the dashboard.

KEY	VALUE
CHROMEDRIVER_PATH	/app/.chromedriver/bin/chromedriver
GOOGLE_CHROME_BIN	/app/.apt/usr/bin/google-chrome

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPLv3 License. See LICENSE for more information.

Authors

• Rohit Ner
• Nishant Nikhil

Acknowledgements

• Hat tip to anyone whose code was used