Skip to main content

A small TLS-encrypted terminal chat app (server + curses client).

Project description

ric-chat-app

A small, TLS-encrypted terminal chat app — a threaded socket server and a curses client, plus a demo time bot. All traffic is encrypted and pinned to a self-signed certificate (encryption + MITM protection).

For chatters (install & run)

pip install ric-chat-app
join-chat

That's it — join-chat connects to the hosted server out of the box, over TLS. Pick a name when prompted and start chatting. Type !exit to leave.

Want the current time in chat? If the time bot is running, send !time.

Running your own server

The package ships only the join-chat client command. To host your own server, clone the repo and run the server module directly:

pip install ric-chat-app
# generate the server's key pair (see DEPLOYMENT.md for the exact command)
python -m ric_chat.server

Point clients at your server with an environment variable or a .env file in the directory you run from:

CHAT_MODE=remote SERVER_HOST=<your.server.ip> join-chat
# or CHAT_MODE=local for a server on 127.0.0.1

Commands

Command What it does
join-chat Launches the curses chat UI (the only installed command)

Self-hosters run the server and demo bot as modules: python -m ric_chat.server and python -m ric_chat.bots.time_bot.

Developing

git clone https://github.com/rickycarrillo3/ric_chat_app
cd ric_chat_app
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest

See DEPLOYMENT.md for the full picture: how TLS pinning works, the package layout, the CI/CD pipeline, and how to deploy/update the VPS.

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

ric_chat_app-0.1.4.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ric_chat_app-0.1.4-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file ric_chat_app-0.1.4.tar.gz.

File metadata

  • Download URL: ric_chat_app-0.1.4.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for ric_chat_app-0.1.4.tar.gz
Algorithm Hash digest
SHA256 9a790cfb934bd32876a62e048c630531a6083323e42f859a36b148c07179de9c
MD5 8f8e74dfecd2251dcc4ffa7c20d8cb40
BLAKE2b-256 ed79d45acba7b2315f99f533cfd0af1227af6a2f97cd9845d8b592a4526cdfdb

See more details on using hashes here.

File details

Details for the file ric_chat_app-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ric_chat_app-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.13

File hashes

Hashes for ric_chat_app-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 f57a6236867a612c2f44b6bed951538291f853626060ca689afffd5ce1289926
MD5 33d6dddd97806c0fd2a0ba6d73e5a20b
BLAKE2b-256 94ecdcd1f10b1f0c21a197239805ce3bbe1dd505a49871aa99fa04305fbd8c7f

See more details on using hashes here.

Supported by

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