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.

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.3.5.tar.gz (39.4 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.3.5-py3-none-any.whl (43.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lantern_chat-1.3.5.tar.gz
  • Upload date:
  • Size: 39.4 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.3.5.tar.gz
Algorithm Hash digest
SHA256 11a8acda04572c4982feed409d461125801040d0725bef3208e8da1d55120806
MD5 15dd0725ec0cabda43ce280817868bb8
BLAKE2b-256 094e9139beaa682c98e910394f35f14cb00b9404bdccad1069d187f3933ffabc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: lantern_chat-1.3.5-py3-none-any.whl
  • Upload date:
  • Size: 43.9 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.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 348afd43cebc9380f2e649702487107236fce5620fcc379196c1bca68c529895
MD5 f4f91c54f227ab791df0b16eb048acf6
BLAKE2b-256 3fff3d23d9758e43b68b5dd1c436c8f889473ea7e57f2eb75380065c0e6d57ed

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