https://github.com/ornella-gigante/gestor-clients-python

This is the final project from my Python curse using Tkinter as UI
https://github.com/ornella-gigante/gestor-clients-python

client-server csv database fastapi mock python testing tkinter-gui tkinter-python

Last synced: 3 months ago
JSON representation

This is the final project from my Python curse using Tkinter as UI

• Host: GitHub
• URL: https://github.com/ornella-gigante/gestor-clients-python
• Owner: Ornella-Gigante
• License: mit
• Created: 2024-08-18T11:48:57.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-24T19:36:00.000Z (about 1 year ago)
• Last Synced: 2025-06-28T03:33:22.105Z (3 months ago)
• Topics: client-server, csv, database, fastapi, mock, python, testing, tkinter-gui, tkinter-python
• Language: Python
• Homepage:
• Size: 6.99 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Client Management Program

## Overview

        This Python program is from a Python course that I made from hektorprofe's repository. The program allows you to manage clients through a command-line interface and is designed to test basic Python skills. 

        Additionally, I've integrated FastAPI to provide a RESTful API for client management, allowing you to manage clients both via the CLI and API.

        

## The program includes functionality to:

    List all clients.

    Search for a client by their ID (DNI).

    Add a new client with fields for name, surname, and DNI.

    Update a client's name and surname based on their DNI.

    Delete a client by DNI.

    Exit the program.

    The program operates with initial test data and does not save data to the disk, ensuring no two clients have the same DNI.

# FastAPI Integration:

    

    GET /clients: List all clients.

    GET /clients/{dni}: Retrieve a specific client by their DNI.

    POST /clients: Add a new client.

    PUT /clients/{dni}: Update an existing client.

    DELETE /clients/{dni}: Delete a client.

    

## List all clients.

    Search for a client by their ID (DNI).

    Add a new client with fields for name, surname, and DNI.

    Update a client's name and surname based on their DNI.

    Delete a client by DNI.

    Exit the program.

    The program operates with initial test data and does not save data to the disk, ensuring no two clients have the same DNI.

## Organization

* Folder Structure:

      Gestor de clientes/

      requirements.txt (empty)

      README.md (empty)

      gestor/ (directory for scripts)

      run.py - Main script to start the application.

      menu.py - CLI menu interface.

      database.py - Manages client data.

      helpers.py - Contains utility functions.

  

* Mock Database:

      Client Class: Defines client attributes and methods for displaying client information.

      Clients Class: Static methods to handle client operations (search, create, update, delete) using a mock list.

* Unit Testing:

      Directory tests/ with __init__.py for test discovery.

      test_database.py for unit tests using unittest.

      Install pytest for running tests: pip install pytest.

      Run tests with: pytest -v.

  

* Menu Implementation:

      Menu options are handled in menu.py.

      Utilizes helpers.py for input validation and clearing the screen.

* CSV Persistence:

      Clients are initially loaded from clientes.csv.

      Changes are saved back to clientes.csv.

      A separate test CSV file tests/clientes_test.csv is used to avoid modifying real data during tests.

  

* GUI Development:

      

      Future enhancements include a GUI using Tkinter:

      MainWindow Class: Main window with Treeview for displaying clients and buttons for actions.

      CreateClientWindow Class: Secondary window for adding new clients with real-time validation.

      Installation and Running

  

* Install Dependencies:

      

      Ensure Python is installed.

      Install required packages (if any) using pip.

  

* Run the Program:

      Execute run.py to start the CLI interface.

  

* Testing:

      Run unit tests with pytest to ensure the program functions correctly.

## License and Copyright

      This project is licensed under the MIT License and belongs to @hektorprofe

      

      For more information, visit--->  https://github.com/hektorprofe

# How does it look: 

![Image_demo](https://github.com/Ornella-Gigante/Gestor-Clients-Python/blob/main/FastAPI.png)

## Demo video:

[Demo](https://github.com/Ornella-Gigante/Gestor-Clients-Python/blob/main/FastAPI.webm)