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.1.tar.gz (48.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.5.1-py3-none-any.whl (55.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.5.1.tar.gz
  • Upload date:
  • Size: 48.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.5.1.tar.gz
Algorithm Hash digest
SHA256 aa18cd3b1a472a015fac4b1eb8d100fd263b619e59869038f02c0bb4238c25fd
MD5 0bca798509a75f9dd75b78431094be21
BLAKE2b-256 89d957d0af020105e84db42139dbfd8d0c46efee26dd11ad0fbb670f9e262a74

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 55.6 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3277b8c45144bf68fa571f0941973a26f34475536e9bd0277f693102a6c2c5d7
MD5 ac2bf1e03178d74b89cf45eeda990a05
BLAKE2b-256 204ee731d83b174441751172662a036f0b5caf8d3ebc59e39c158e5ff6dd716d

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