85 lines
2.3 KiB
Markdown
85 lines
2.3 KiB
Markdown
|
|
# Personal Finance Database
|
|
|
|
This project aims to manage personal finance data using a Google Sheets-based database. It provides tools to import data from PDF statements, perform basic personal financial analysis, and visualize the data.
|
|
|
|
## Features
|
|
|
|
- **Data Ingestion:** Import data from Google Sheets and PDF statements.
|
|
- **Data Processing:** Clean and preprocess the data for further analysis.
|
|
- **Data Analysis:** Conduct basic personal financial analysis.
|
|
- **Data Visualization:** Create simple and understandable visualizations of financial data.
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
personal-finance-database/
|
|
├── .git
|
|
├── data/
|
|
│ ├── raw/
|
|
│ │ ├── your_file.pdf
|
|
│ ├── processed/
|
|
│ └── external/
|
|
├── src/
|
|
│ ├── __init__.py
|
|
│ ├── data_ingestion/
|
|
│ │ ├── __init__.py
|
|
│ │ ├── google_sheets_api.py
|
|
│ │ └── pdf_parser.py
|
|
│ ├── data_processing/
|
|
│ │ ├── __init__.py
|
|
│ │ └── data_cleaner.py
|
|
│ └── analysis_visualization/
|
|
│ ├── __init__.py
|
|
│ ├── financial_analysis.py
|
|
│ └── data_visualization.py
|
|
├── tests/
|
|
│ ├── __init__.py
|
|
│ ├── test_data_ingestion.py
|
|
│ ├── test_data_processing.py
|
|
│ └── test_analysis_visualization.py
|
|
├── notebooks/
|
|
│ ├── notebook1.ipynb
|
|
│ ├── notebook2.ipynb
|
|
│ └── ...
|
|
├── docs/
|
|
├── .gitignore
|
|
├── README.md
|
|
└── requirements.txt
|
|
```
|
|
|
|
## Installation
|
|
|
|
Clone this repository to your local machine.
|
|
|
|
```bash
|
|
git clone https://github.com/your-github-username/personal-finance-database.git
|
|
```
|
|
Navigate to the project directory.
|
|
|
|
```bash
|
|
cd personal-finance-database
|
|
```
|
|
Install the necessary packages.
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
## Usage
|
|
|
|
Details on how to use the project will be updated as the project progresses.
|
|
|
|
## Contributing
|
|
|
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
|
|
## License
|
|
|
|
[Choose an open source license and mention it here.]
|
|
|
|
## Contact
|
|
|
|
[Your Name] - [Your Email] - [Your LinkedIn/GitHub/Twitter etc.]
|
|
|
|
Remember to replace the placeholders with your actual details.
|