https://github.com/cromega08/chathon

A CLI chat application written in pure python code.
https://github.com/cromega08/chathon

chat chat-application cli cli-app cli-application cli-chat client-server python python-3 python-3-10 python-310 python3 python310 socket socket-io socket-programming sockets

Last synced: 27 days ago
JSON representation

A CLI chat application written in pure python code.

• Host: GitHub
• URL: https://github.com/cromega08/chathon
• Owner: cromega08
• License: agpl-3.0
• Created: 2022-06-30T20:46:03.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-01T23:04:29.000Z (over 2 years ago)
• Last Synced: 2024-11-11T23:35:11.108Z (3 months ago)
• Topics: chat, chat-application, cli, cli-app, cli-application, cli-chat, client-server, python, python-3, python-3-10, python-310, python3, python310, socket, socket-io, socket-programming, sockets
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# ChaThon

ChaThon it's a CLI implementation of a chat application.

Works as a ChatRoom where one of the users as like server for all participants, included itself.

It's a pure python creation and works with built-in modules of python.

## Requirements

* Python 3.10+

* XTerm terminal (this it's commonly included in linux sistems)

## Installation

The project include a setup.py file ready to use with pip.

After cloning the repository, just write:

```bash

pip install /path/to/ChaThon/folder

```

If you want to modify the files and not reinstall every time, write:

```bash

pip install -e /path/to/ChaThon/folder

```

## Usage

* To start a new ChatRoom, acting as the server

    ```bash

    chathon server -n {number of participants}

    ```

    * **Note:** ChaThon generate a random port each time. If you want to use a specific port, write:

    ```bash

    chathon server -n {number of participants} -p {positive number lower than 65000}

    ```

* To join a ChatRoom

    ```bash

    chathon client -ip {ip of the host} -p {the port activated for the host}

    ```

## Examples

* Start a server

```bash

chathon server -n 1 -p 1234

```

* Connect to a server

```bash

chathon client -p 127.0.0.1 -p 1234

```

## Authors

* [@Cromega08](https://www.github.com/cromega08)

## License

* [GNU AGPL v3.0](https://choosealicense.com/licenses/agpl-3.0/)