mqtt_chat

A command line chat client using the MQTT protocol, written in Python.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

mqtt_chat is a light weight command line chat client written in python that uses MQTT to distribute messages and controls the terminal with ANSI control characters.

(back to top)

Built With

• Python3
• PahoMQTT

(back to top)

Getting Started

Installation

1. Open your terminal
2. Use pip to get the package as

   python3 -m pip install mqtt_chat

(back to top)

Usage

Run as

python3 -m mqtt_chat -d your_displayname -b mqtt.broker.address -t your/chatroom/topic

Exit by hitting ctrl+c

(back to top)

Roadmap

• Implement obfuscation of plain text
• Bundle a broker app to support setup and use over purely local networks

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/burnish3d/mqtt_chat

(back to top)