Skip to content

Latest commit

 

History

History
122 lines (92 loc) · 3.85 KB

README.md

File metadata and controls

122 lines (92 loc) · 3.85 KB
Raw

📞 ContactFlow

ContactFlow Interface

🎯 Modern and intuitive contact management interface showcasing our clean design philosophy and user-centric approach

A versatile contact management system that makes organizing connections effortless. Built with Python, ContactFlow offers both GUI and CLI interfaces with multiple storage options, making it perfect for both personal and professional use.

Why ContactFlow?

  • ✨ Modern GUI interface with dark mode support
  • 🖥️ Dual interface options (GUI/CLI)
  • 💾 Multiple storage options (JSON/SQLite)
  • 🔍 Advanced contact search
  • ➕ Easy add/remove functionality
  • 🔄 Real-time updates
  • 📊 Contact history tracking

✨ Features

  • 🎨 Modern GUI interface with customizable themes
  • ➕ Add contacts with name, phone, email, and notes
  • ❌ Remove contacts by name or ID
  • 📋 Display contacts in table or list view
  • 💾 Choice of JSON or SQLite storage
  • 📅 Contact creation date tracking
  • 🔍 Advanced search functionality
  • 💫 Auto-save and load functionality

🛠️ Available Interfaces

1. GUI Interface

Modern graphical interface with:

  • Sidebar navigation
  • Contact table view
  • Search functionality
  • Settings panel
  • Themed components

2. CLI Interface

Traditional command-line interface for:

  • Quick access
  • Script automation
  • Server environments

🔧 Technical Details

  • 🐍 Written in Python
  • 🎨 Uses tkinter and customtkinter for GUI
  • 📦 Supports both JSON and SQLite storage
  • ⚠️ Comprehensive error handling
  • 🕒 Datetime tracking for contacts
  • 💾 Automatic data persistence

📁 File Structure

  • GUI.py: Modern graphical interface
  • update.py: Traditional CLI interface
  • sample.py: SQLite implementation
  • contacts.json: JSON storage
  • contacts.db: SQLite database

🚀 Usage

GUI Version

  1. Run GUI.py
  2. Use the sidebar for navigation
  3. Add, view, or search contacts
  4. Access settings for customization

CLI Version

  1. Run update.py or sample.py
  2. Choose from the menu options:
    • 🔵 Add contact
    • 🔴 Remove contact
    • 📋 Show contacts
    • 🔍 Search contacts (SQLite version)
    • 🚪 Exit

Note: ContactFlow is a basic contact management system suitable for learning purposes and simple contact storage needs. 🎯

👨‍💻 Contributing

Feel free to fork this project and enhance it with new features!

📄 License

This project is licensed under the MIT License.

View License Text

MIT License

Copyright (c) 2024 ContactFlow

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

🤝 Support

If you have any questions or need help, feel free to open an issue!

This project is created by @moelkenzi at SNU and @Gabaxey at Zam-Zam University.