Skip to main content

Local network chat messaging application

Project description

Unit tests Pylint License: MIT

pychatter

pychatter is a direct chat tool, which may be run to communicate over a local network.

Gif of the application GUI

Communication happens over the localhost port 8080.

This is primarily an exercise in duplex client-server communication using websockets.

Getting started

Install the pychatter package using pip, then run the package:

python -m pip install pychatter
python -m pychatter

Hosting a chat server can be done directly inside the graphical user interface, or a dedicated server may be started from the command line using:

python -m pychatter --server

⚠️ State of the repository ⚠️

This repository is unlikely to receive new features in the future, although maintenance and small fixes will still be done.

This means that some features that are missing now will stay missing (but feel free to submit a pull request to add them!), and non-optimal aspects of the codebase or the application are unlikely to get fixed.

Configuration

The chat application supports external configuration files. Place a file named config.json in the directory from which the application is run.

The configuration file currently supports one setting, "chat_format", which is used to display chat messages. It supports the following placeholder strings:

  • %T: time
  • %U: user name
  • %M: message

An example config.json could contain the following data:

{
	"chat_format": "%T: %U: %M"
}

Contributions

To contribute to this repository, please read the contribution guidelines.

Python

Written in Python 3.7.3.

License

This repository is open-source software available under the MIT License.

Contact

Please raise an issue for code changes. To reach out, please send an email to richard@baltrusch.net.

Attributions

Icons made by Freepik from www.flaticon.com.

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

pychatter-0.1.3.tar.gz (17.1 kB view details)

Uploaded Source

Built Distribution

pychatter-0.1.3-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file pychatter-0.1.3.tar.gz.

File metadata

  • Download URL: pychatter-0.1.3.tar.gz
  • Upload date:
  • Size: 17.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for pychatter-0.1.3.tar.gz
Algorithm Hash digest
SHA256 bf7faba52c451a50d556ac4fc394ee6b0db75c22ed897c377e3e866ea58b82bc
MD5 76d67cc197a102e41a90b7e34737462f
BLAKE2b-256 1769eb34e5a5f3f251f87c369b008f2b0737d5c247562fece5eacbec0f29b9d7

See more details on using hashes here.

File details

Details for the file pychatter-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: pychatter-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.4

File hashes

Hashes for pychatter-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bbdb81081dc46f166de8f9cdd87b6188153c9920177b705a53bd1a17306a0271
MD5 089b44c1e3564133b613ad9afc41b69e
BLAKE2b-256 db7fce5879e2144ed28926f847921cc802c2f188344602f5fdef0773ec334e9b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page