https://github.com/kraanzu/gupshup
A TUI chat application writtten in python
https://github.com/kraanzu/gupshup
chat-application python3 rich textual tui
Last synced: 3 months ago
JSON representation
A TUI chat application writtten in python
- Host: GitHub
- URL: https://github.com/kraanzu/gupshup
- Owner: kraanzu
- License: mit
- Archived: true
- Created: 2022-01-15T10:55:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-07T03:07:37.000Z (over 2 years ago)
- Last Synced: 2024-11-05T04:34:06.851Z (8 months ago)
- Topics: chat-application, python3, rich, textual, tui
- Language: Python
- Homepage:
- Size: 335 KB
- Stars: 371
- Watchers: 4
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ⚠️Archive⚠️
Archiving this as the I made so many bad implementations lol XD \
I'll make a new and better chat app soon 😄
# Gupshup
Gupshup is TUI (Text User Interface) chat application with a great UI and feel!
It implements various features as modern chat applications
such as ranking systems and special commands.
see [here!](https://github.com/kraanzu/gupshup/blob/main/COMMANDS.md)
It is good for now but I'll add more features to it :)
There is a screenshot of the application attached below which will make it easier for you to understand the concept.
And also, It is built on top of [textual](https://github.com/Textualize/textual) which provides the UI for the application
Shoutouts to [@willmcgugan](https://github.com/willmcgugan) for such a great library!
# Installation
***Note:*** Termtype needs python version ^3.10
***Note:*** The default icons used in the app are a part of [Nerdfonts](https://www.nerdfonts.com/)
***Note:*** This might not work on windows as intended but windows support is in pipeline and textual is working on it!
## One Liner
```bash
python3 -m pip install git+https://github.com/kraanzu/gupshup.git
```
## Or if you prefer Manual Installation
``` bash
git clone https://github.com/kraanzu/gupshup.git
cd gupshup
pip install .
```
# A screenshot of the application
# Usage
A script be automatically generated to run it with a simple command gupshup in your terminal
**For spinning up a server:**
```bash
gupshup --server
```
**For connecting to a server:**
```bash
gupshup -u
```
**Note: You can add -q flag to supress notification sounds**
```bash
gupshup -u -q
```
# TODOs
- [ ] Add bots
- [ ] File Uploads
# Contribution
Always open to PRs :)
