https://github.com/rbaltrusch/pychatter

A minimal chat application for local network communication, including server hosting capabilities.
https://github.com/rbaltrusch/pychatter

chat chat-application chatapp chatroom communication graphical-user-interface gui networking pychatter python python3 server socket socket-programming tkinter tkinter-gui

Last synced: 3 months ago
JSON representation

A minimal chat application for local network communication, including server hosting capabilities.

• Host: GitHub
• URL: https://github.com/rbaltrusch/pychatter
• Owner: rbaltrusch
• License: mit
• Created: 2021-05-18T19:02:05.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-07T21:02:41.000Z (3 months ago)
• Last Synced: 2024-11-07T22:17:55.424Z (3 months ago)
• Topics: chat, chat-application, chatapp, chatroom, communication, graphical-user-interface, gui, networking, pychatter, python, python3, server, socket, socket-programming, tkinter, tkinter-gui
• Language: Python
• Homepage:
• Size: 18.3 MB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![Unit tests](https://github.com/rbaltrusch/pychatter/actions/workflows/pytest-unit-tests.yml/badge.svg)](https://github.com/rbaltrusch/pychatter/actions/workflows/pytest-unit-tests.yml)

[![Pylint](https://github.com/rbaltrusch/pychatter/actions/workflows/pylint.yml/badge.svg)](https://github.com/rbaltrusch/pychatter/actions/workflows/pylint.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-purple.svg)](https://opensource.org/licenses/MIT)

# pychatter

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

![Gif of the application GUI](https://github.com/rbaltrusch/pychatter/blob/master/pychatter/gui/media/gif1.gif?raw=true "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:

```json

{

	"chat_format": "%T: %U: %M"

}

```

## Contributions

To contribute to this repository, please read the [contribution guidelines](https://github.com/rbaltrusch/pychatter/blob/master/CONTRIBUTING.md).

## Python

Written in Python 3.7.3.

## License

This repository is open-source software available under the [MIT License](https://github.com/rbaltrusch/pychatter/blob/master/LICENSE).

## Contact

Please raise an issue for code changes. To reach out, please send an email to [email protected].

# Attributions

Icons made by Freepik from www.flaticon.com.