Payment Report Generator & Dashboard App

This project consists of two key components:

• Payment Report Generator: A Django management command to process payment transaction data from a CSV file and generate detailed reports.
• Payment Dashboard: A web application that provides an overview of payment transactions with the ability to visualize data through charts. It allows users to view various statistics on payments, including payment status (successful, cancelled, failed, refunded).

Features

Payment Dashboard:

• Payment Overview: Displays monthly earnings and payment status distributions.
• Analytics: View detailed statistics on payment success, cancellations, and more.
• User Authentication: Secure login/logout and profile management.
• Reports View Page: A web interface to view reports:
  • Days from Suspension Report
  • Agent Collection Report
  • Payment Type Report

Payment Report Generator:

• CSV Upload: Import payment data via CSV for easier bulk entry.
• Data Extraction & Cleaning: Extract and clean payment data from CSV files.
• Reports Generation: Generate three types of reports:
  • Days from Suspension Report: Lists clients and their days from suspension.
  • Agent Collection Report: Shows collections per agent, per day, and per payment type.
  • Payment Type Report: Displays total payments per payment type.
• CSV Output: Saves the generated reports in CSV format to a specified output folder.

Requirements:

• python 3.13.0
• pre-commit
• virtualenv

Getting Started

1. Clone the Repo

$ git clone https://github.com/g1039/payment-report-generator.git
$ cd payment-report-generator

2. Create and Activate Virtual Environment

$ virtualenv ve
$ source ve/bin/activate

3. Install Dependencies

$ pip install -r requirements.txt
$ pre-commit install

4. Setup database

$ python manage.py makemigrations
$ python manage.py migrate
$ python manage.py createsuperuser

5. Run Tests

$ pytest

6. Run the Development Server

$ python manage.py runserver

You can now access the demo site on http://localhost:8000

Management Command Usage

To run the Payment Report Generator management command and generate reports from a CSV, use the following command in your terminal:

python manage.py process_payment_reports <input_file> <output_folder>