pychatter 0.1.0

Local network chat messaging application

pychatter

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

Communication happens over the localhost port 8080.

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

Getting started

To get a copy of this repository, simply open up git bash in an empty folder and use the command:

$ git clone https://github.com/rbaltrusch/pychatter

To install all python dependencies, run the following in your command line:

python -m pip install -r requirements.txt

To run the application, run the package from the root repository directory:

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

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"
}

Tests

To run tests, change to the tests directory, then run run_tests.py:

cd tests
python run_tests.py

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 [e-mail].

Attributions

Icons made by Freepik from www.flaticon.com.