Skip to main content

Textual open chatting

Project description

🙏 Jobdam - Terminal TUI open chatting APP 🙏

Enjoy simple open chatting in the terminal!

Introduction

Jobdam, meaning "chat, small talk, chitchat" in Korean, is a TUI (Text User Interface) open chatting application built with a simple UI. It allows anyone to easily engage in open chatting in the terminal without the need for authentication or sign-up.

🛎 Current Version 0.1.2

Upgrade with pip install jobdam --upgrade

🚀 Installation & Settings

  • Requires Python version >3.11 to be installed.
  • Installable in the terminal using the following command:
pip install jobdam

Some shells can damage the UI, and we recommend it to be used on the full screen, preferably.

👨‍💻 Instructions

  • The screen consists of various widgets. You can navigate conveniently with the TAB key and select a Room using the up and down arrow keys.
  • To create a Room, you need to input Room Name, Tag, and Maximum people. The Maximum people limit is up to 10.
  • Owners can ban guests and change room settings.

📸 Screenshot

Main

Navigate up and down using the TAB key and select with the Enter key.

Register

Similar to the main screen, navigate with the TAB key. The green text in the center corresponds to the validator for each input field.

Login

Similar to the register screen.

Search Screen

  • The left side shows the rooms you've joined, and the center lists rooms created by other users.
  • The input field at the top center allows you to search for rooms by Room name or #tag.
    • e.g., #Language

Create room Screen

Clicking the Create Room button on the search screen brings up the following screen.

  • Set Room Name, Tag, and Maximum people, each with its own validator.

Chat room Screen

  • The left side displays rooms you've joined. If it's your room, you can join another room at any time.
  • The main center screen shows the chat history.
  • The right screen lists the people in the room. Owners can ban unwanted guests with the Enter key.
  • The Setting button at the bottom left allows owners to change room settings.
  • The Exit button deletes the room if you're the owner or simply exits the joined room if you're a guest.

💬 Remarks

When entering a room, a WebSocket connection is established, and the connection is immediately terminated upon exiting the app.

I wanted the WebSocket to persist for the duration of the access token's validity to send notifications. However, I have not yet found a way to maintain it with my limited knowledge.

I will strive to make this possible as quickly as possible.

🚮 Uninstalling

If, by any chance, due to unforeseen circumstances, you wish to uninstall, you can do so with the following command:

pip uninstall jobdam

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jobdam-0.1.5.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

jobdam-0.1.5-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file jobdam-0.1.5.tar.gz.

File metadata

  • Download URL: jobdam-0.1.5.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.6 Windows/10

File hashes

Hashes for jobdam-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c6091228f7690b66062c4af5359707045ad0f42ec07877c7d4fba5e14cc92fbe
MD5 7867dadf71c8777ca9dc3052119b9ccb
BLAKE2b-256 f6d5ee4cb06a8453d0215f3d59a7a901e08ef75dffd93611913e7f54561c873d

See more details on using hashes here.

File details

Details for the file jobdam-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: jobdam-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.6 Windows/10

File hashes

Hashes for jobdam-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 efa523c06f38ba437522e98fa0ac4ce00389cdc7233be54da972bd674d6297e6
MD5 a2ca8bbc46848cc606cf31e30709edf7
BLAKE2b-256 d96c383a6058e2e032a29c0b3e789de7108a950781b4083d9edd6d88657c6262

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page