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.0.2.tar.gz (32.1 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.0.2-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.0.2.tar.gz
  • Upload date:
  • Size: 32.1 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.0.2.tar.gz
Algorithm Hash digest
SHA256 8517363a0a6577b2bb9bc1ec9b3f2f89f4e567916934fb02221686f122c5cd6f
MD5 46d1a9a082899d9a6c45502d86c499e7
BLAKE2b-256 ee3098bfb764d72382e1b355aef781600c9e07ba746988dbb6e239bcd67fe557

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.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.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2433ae29cd9dfc62d8cdf9a051c6cf937ae8bbe90832cbf9eb9acd60dbcc59dc
MD5 e5d16a062b1c5bfdc0fe7a6abda2e90c
BLAKE2b-256 1dfe09e04c7007a5843d24e087d7675fd9e9b8658497d61d3e95dba94c4dc01a

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