Skip to main content

A TUI chat application for your terminal

Project description

Lantern

A curses based chat client and server.

PyPI - Downloads

Screenshots

image

Getting Started

Note: Lantern is not designed to be hugely secure, so don't use it for anything you care about. Please ... Additionally, this has been tested primarily on Linux, so there are likely to be some issues on other platforms. If you find any, please report them or better yet, fix them and make a pull request. I am unable to test on Windows so I would appreciate any PR's that add support for it.

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.

Compatibility

  • Linux (fully supported, tested on Fedora, Asahi Fedora, Arch)
  • MacOS (supported but not tested in depth)
  • Windows (seems to work but is untested, there are likely to be some issues)

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.5.0.tar.gz (47.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.5.0-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.5.0.tar.gz
  • Upload date:
  • Size: 47.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.5.0.tar.gz
Algorithm Hash digest
SHA256 ea50afd9285762f574b72051825c5eec9ab518354b3a3ba4683bc9c2212a3a3d
MD5 225ff02cd9ab85710b6857f5515dd011
BLAKE2b-256 675da1c8cc27530f8e98a723d52e58ba21ce4f7a7e2fa6f785e0cf2f7a6c95c1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 55.2 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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0dafdc08c62b99a548231ceac086062ece4ff01292e529f6943a62f37d06f6c4
MD5 32e7dd36b52c99cd5a35f79af2a548b9
BLAKE2b-256 ae9d40ca1fccf8ffe47a142db51aef663dbe13681ee0640dbf2ab29aa5ff9f9a

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