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

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.2.8.tar.gz
  • Upload date:
  • Size: 37.8 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.8.tar.gz
Algorithm Hash digest
SHA256 6d4c1b45eaa719926754828d8620bf22786a61d9f0401268fbd8c02f0720eab5
MD5 0c1a0926936c718e5d9e8c86d0d57e76
BLAKE2b-256 afa6d74c9c773335dc8224bd82ddff06df2ddd2b8aa2b5dc3264ca098d2ad90c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.2.8-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.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 5c9d3905aba1f71bcba195324748511c126b7393d99c3fd8b8463a3c9e9413c0
MD5 f1c123407c7401a4d21b48f06ceb1c47
BLAKE2b-256 1650c1a540666a1aa128f0e0e4b1a084497eeb9895b14464eb61e580e877742c

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