PyBank Command-Line Interface 🐍

A Python application simulating essential banking operations through a command-line interface, built using object-oriented principles.

---

Project Overview

PyBank CLI provides a text-based environment for interacting with a simulated banking system. It demonstrates core concepts like account management, transactions, and user handling in Python. This project is under active development, and contributions aimed at improving its stability and functionality are encouraged.

---

Capabilities

• Account Creation: Supports different account types (e.g., Savings, Current).
• User Management: Add and manage user profiles linked to accounts.
• Transactions: Perform deposits and withdrawals.
• Information Retrieval: Check account balances.

---

Technology Stack

• Core Language: Python 3
• Dependencies: Managed via requirements.txt (see file for details)

---

Setup and Execution

Prerequisites:

• Ensure Python 3 is installed on your system.
• pip (Python package installer) should be available.

Installation & Launch:

1. Clone this repository to your local machine.
2. Open a terminal or command prompt and navigate to the project's root directory.
3. Install the necessary packages:

   pip install -r requirements.txt

4. Execute the main application script:

   python main.py

---

Code Structure

The application is organized into the following main components:

PyBank-CLI/
├── account/          # Contains BankAccount classes and User class
│   ├── bank_account.py
│   └── user.py
├── bank_operator/    # Implements the core banking logic
│   └── bank_operator.py
├── main.py           # Entry point and CLI interaction handler
└── requirements.txt  # Lists project dependencies

(Known issues or areas needing refinement may exist; please consult the GitHub Issues tracker or explore the code.)

---

How You Can Help

Interested in improving PyBank CLI? Here's how:

1. Identify Issues: Run the application and look for bugs, unexpected behavior, or potential enhancements. Check the GitHub Issues list for reported items.
2. Develop Solutions: Implement fixes or improvements in the relevant Python modules (account, bank_operator, main).
3. Submit Changes: Propose your changes via a Pull Request, clearly explaining the problem addressed and the solution implemented.

---

Code Validation via CI

To maintain code quality, an automated testing pipeline runs for every Pull Request submitted. These tests verify that the core banking operations function as expected with the proposed changes. Contributions must pass these checks to be considered for merging.

---

We appreciate your interest in developing PyBank CLI.