To use this tool, open the network tab and submit the FSR, capture the submission data into and copy the object into data/submission-object.json, then run the script in terminal.
This script reads data from a JSON file (submission-object.json
) (non-PII), calculates the total monthly income and expenses, and generates a summary report in Markdown format.
This script is written in Python and uses the following libraries:
pandas
json
To install these libraries, you can use pip
, Python's package installer. You can install them with the following commands:
pip install pandas
The json module comes pre-packaged with Python, so you don't need to install it separately.
Once the dependencies are installed, you can run the script using Python:
python main.py
Note: If you have both Python 2 and Python 3 installed on your system, you might need to use python3 instead of python.
python3 main.py
The script reads from a JSON file located at ./data/submission-object.json. Make sure this file exists and is in the correct format.
The script writes the summary report to a Markdown file located at results/summary.md. Make sure the /data directory exists and is writeable. If you want to write the output to a different location, modify the script to change the output path.
If you encounter any issues while running the script, first make sure your JSON file is in the correct format and location.
- Monthly gross salary: $11000.00
- Total deductions: $3110.00
- Net take home pay: $7890.00
- Other income: ${'name': '', 'amount': '0.00'}
- Total monthly net income: $7890.00
- Monthly gross salary: $0.00
- Total deductions: $0.00
- Net take home pay: $0.00
- Other income: ${'name': 'Disability Compensation, Education, Child support', 'amount': '1700.00'}
- Total monthly net income: $1700.00
- Rent or Mortgage: $2200.00
- Food: $500
- Utilities: $490.00
- Other living expenses: ${'name': "Clothing, Entertainment, Family and child care, Health expenses, Household maintenance, Pet care, Legal fees, Transportation and car expenses, Renter's or home insurance", 'amount': '1900.00'}
- Expenses installment contracts and other debts: $1222.00
- Total monthly expenses: $6312.00
- Expected Discretionary Income: $3278.00
- Actual Discretionary Income: $3278.00
- Estimated amount: $3278.00
- Committed amount: $30.51
All tests passed.