A Python-based contact management application that allows users to add, view, update, and delete contact information easily. This project is designed to help organize and manage contacts efficiently using a simple interface.
- 📇 Add Contacts – Store contact details such as name, phone number, and email.
- 🔍 View Contacts – Retrieve and display stored contact information.
- ✏️ Update Contacts – Modify existing contacts as needed.
- ❌ Delete Contacts – Remove unwanted contacts.
- 🛡️ Validation – Ensures correct data format before saving.
- 🛠 Modular Codebase – Easy to extend and customize.
📂 contacts/
│── 📄 main.py # Entry point of the application
│── 📄 IOStream.py # Handles input and output operations
│── 📄 managers.py # Manages core contact operations
│── 📄 models.py # Defines the contact data structure
│── 📄 validations.py # Ensures valid user input
│── 📄 tests.py # Unit tests for validation and contact functions
│── 📂 database/ # Stores contact data (if using a file-based approach)
│── 📄 .gitignore # Git ignore file
│── 📄 LICENSE # Project license
│── 📄 README.md # Documentation
-
Clone the Repository:
git clone https://github.com/Asalghaani/contacts.git
-
Navigate to the Project Directory:
cd contacts -
(Optional) Set up a Virtual Environment:
python -m venv venv source venv/bin/activate # On macOS/Linux venv\Scripts\activate # On Windows
-
Install Dependencies:
pip install -r requirements.txt
Run the application:
python main.pyFollow the prompts to add, update, view, or delete contacts.
To ensure everything is working correctly, run:
python tests.pyWant to contribute? Follow these steps:
- Fork the Repository 📌
- Create a New Branch (
git checkout -b feature-branch) - Make Your Changes & Commit (
git commit -m 'Add feature') - Push to Your Branch (
git push origin feature-branch) - Submit a Pull Request 🚀
This project is licensed under the MIT License. See the LICENSE file for more details.
Just copy and paste this into your **README.md** file, and you're all set! 🚀🔥 Let me know if you need any modifications!