Skip to main content

A lightweight TUI chat application for your terminal

Project description

Lantern

A curses based chat client and server.

PyPI - Downloads

Screenshots

image

Getting Started

Prerequisites

  • Python
  • Pip package manager
  • a brain

Installation

pip install lantern-chat

Usage

To start the server, run:

lantern-server

You can specify a custom port with the -p flag, for example:

lantern-server -p 12345

To start the client, run:

lantern

You can specify the server host and port with the -s and -p flags, for example:

lantern -s 1.1.1.1 -p 12345

The default port is 6000 and default server host is localhost.

All client and server config is saved to ~/.config/lantern/config.json and ~/.config/lantern/server_config.json respectively. In the server config, you can set the server admins, port, message and fetch cooldown.

Details

Lantern requires a server to be running at the configured host and port for clients to be able to connect and communicate. This can either be locally (using default server IP and port in client config) which will allow you to communicate across a LAN or by setting up the server on a public facing IP (eg using a VPS) or by tunnelling a port on your local network to a publicly accessible IP.

Contributing

Just make a pull req. lol

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

lantern_chat-1.2.5.tar.gz (36.3 kB view details)

Uploaded Source

Built Distribution

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

lantern_chat-1.2.5-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file lantern_chat-1.2.5.tar.gz.

File metadata

  • Download URL: lantern_chat-1.2.5.tar.gz
  • Upload date:
  • Size: 36.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for lantern_chat-1.2.5.tar.gz
Algorithm Hash digest
SHA256 509e16a31da8231b03191fe9e76dd4e36eab9119a0fedf39a16dad819f077ad1
MD5 ed2220c709dec103eb1633246e4108d6
BLAKE2b-256 13002567aa996d40cf8fab77b9e9bc628798e4492a2d8d2e3d20fc6a825095ff

See more details on using hashes here.

File details

Details for the file lantern_chat-1.2.5-py3-none-any.whl.

File metadata

  • Download URL: lantern_chat-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for lantern_chat-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 305972499b916a0be25fa7eb90f95be255fb19092166ec06a8314aa7c0fd8c1f
MD5 30520c980121c76214b8b4c6bfe5e59f
BLAKE2b-256 9c90f687323c27ff70fdc511d8f9c53e14500c72430023abbddd22d86f64c761

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