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.4.tar.gz (35.9 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.4-py3-none-any.whl (39.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.2.4.tar.gz
  • Upload date:
  • Size: 35.9 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.4.tar.gz
Algorithm Hash digest
SHA256 a0f2b3c6aacab700a201c8d469dfeec3f7a6c5a195c0f76039437965adcfb170
MD5 84412c761cd92a901f31ead2b213a2ae
BLAKE2b-256 c5bf8997e16a62df1f1247af435dd25a0875cb84d9d9dcacb3f92646e03bd6e9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 39.1 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 847d096c276689f39a25f9b57d4f9516b9af502adeed05791030c91b8db86627
MD5 a3210819deb3b270cce90f881de46a01
BLAKE2b-256 65a9a89ef49135f8e54d87c545208d252fa154246b045494d2e91577e4045716

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