README.md

Chat App TUI

to see the french version of this README go to assets/docs/README-FR.md

a personal terminal chat app to improve my python skill

download this chat app

1. on terminal/cmd

git clone https://github.com/Saverio976/Chat-App-TUI.git Chat-App-TUI-main

2. on a browser

set up the project

• open a [terminal / command prompt] on this project path (tips for Windows : assets/docs/open_cmd.md)

• and install all required library

python -m pip install --upgrade pip

on windows

python -m pip install -r aseets/requirements/win.txt

on other os

python -m pip install -r assets/requirements/nix.txt

launch the project

• on a [terminal / command prompt] open in the project directory

python main.py

update the project

• on the project path open a [terminal/ command prompt]

python settings/update.py

Chat App

The first time you will run this app-like, it will ask you a pseudo

This pseudo will be print to all present people on a channel when you will send a message, join the channel, or other stuff

To Read

you can now send a file and download it (check /help for more info)

a new incoming command named /switch_channel <channel_name> but not finish so you need to wait more time to speak in more than one channel

/set_cipher come back ! ( command to set a cipher key for sending message )

/history is a command to save all message in a file (assets/data/history.txt) /history True : save message /history False : no longer save message default on every launch : False

in app commands :

┌────────────────────────────────────────────────┬─────────────────────────────────────────────────────────┐
│ commande                                       │ expliquation                                            │
├────────────────────────────────────────────────┼─────────────────────────────────────────────────────────┤
│ help                                           │ affiche toutes les commandes                            │
│ help <commande>                                │ affiche la description de cette commande                │
│ exit                                           │ ferme l'appli                                           │
│ whohere                                        │ affiche tous les membres connecté sur se salon          │
│ set_cipher                                     │ desactive les messages codé                             │
│ set_cipher <motClef>                           │ active les messages codé avec cette clefs de chifrement │
│ ping <message a envoyer >                      │ envoi un message en surbrilliance                       │
│ up                                             │ sroll vers le haut d'un message                         │
│ up <nombre>                                    │ scroll vers le haut du nombre de message                │
│ down                                           │ sroll vers le bas d'un message                          │
│ down <nombre>                                  │ scroll vers le bas du nombre de message                 │
│ history True                                   │ enregistre dans un fichier chaque message reçu          │
│ history False                                  │ desactive l'enregistrement                              │
│ send_file <chemin_absolu_du_fichier>           │ envoi un fichier dans le tchat                          │
│ download_file <ID du fichier> <nom du fichier> │ telecharge un fichier envoyé dans le tchat              │
└────────────────────────────────────────────────┴─────────────────────────────────────────────────────────┘

Thanks

Contact

before send a mail, please let an issue, or a PR