Metadata-Version: 2.1
Name: budgetize
Version: 0.0.2
Summary: A Terminal User Interface (TUI) to create budgets, track your incomes/expenses and manage your finances.
Project-URL: Homepage, https://github.com/fer-hnndz/budgetize
Project-URL: Issues, https://github.com/fer-hnndz/budgetize/issues
Author-email: Jorge Hernández <jfernandohernandez28@gmail.com>
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: arrow
Requires-Dist: requests
Requires-Dist: sqlalchemy
Requires-Dist: textual
Description-Content-Type: text/markdown

# Budgetize
A Terminal User Interface (TUI) that allows you to manage your finances.

**✨ Features**
- Manage various accounts by adding income/expense transactions.
- Visualize your monthly balance
- Generate reports of your finances. **(planned to add in the future.)**

# ⚙ Installation

Currently, Budgetize is not being distributed with binaries.\
The only way for now to run it is with the source code.

### 👨‍💻 Installing from Source

1. Clone the repository
```bash
git clone https://github.com/fer-hnndz/budgetize.git
```
2. Install dependencies
```bash
pip install -r requirements.txt
```
***NOTE: It is recommended to create a virtual environment***\
3. Start Budgetize
```bash
python main.py
# Or you can run it with the textual module
textual run main.py
```

# 🗺 Roadmap
You may check the project's roadmap in the open projects.\
[**Go To Projects**](https://github.com/fer-hnndz/budgetize/projects?query=is%3Aopen)

# Contributing

TO-DO

# License
Budgetize uses the [General Public License v3](LICENSE)

# 🔧 Built With
- [Textual](https://textual.textualize.io/) - TUI framework
- [SQLAlchemy](https://www.sqlalchemy.org/) - ORM toolkit to store user's data
