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.3.0.tar.gz (37.6 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.3.0-py3-none-any.whl (42.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.3.0.tar.gz
  • Upload date:
  • Size: 37.6 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.3.0.tar.gz
Algorithm Hash digest
SHA256 35857c03c49743fbab8a546b630ace20c1d6b1fac7497072c737ad7e2ecb69b9
MD5 6afd3ef2252794f5d36c9dfa3e7b9c98
BLAKE2b-256 4e829f81300238cb084638b15b70ab00aa32efa11b95f97f41b7d403d0b77e48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 42.3 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3b5526f1e619c86387dfdef929377d25ee1ce400d59b6340919199b09aeefc99
MD5 cdd0e38ab36580fb306a88f4f3d780b6
BLAKE2b-256 b347ff099c43166c9fbf5bfe31596b8e1578f82095c3a47376c5d21b5a145228

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