Metadata-Version: 2.1
Name: littlechat
Version: 0.0.7
Summary: A little chatroom run in console base on `urwid` and `UDP`, only support Linux, OSX, Cygwin or other unix-like OS
Home-page: https://github.com/yujun2647/littlechat
Download-URL: 
Author: walkerjun
Author-email: yujun2647@163.com
License: Apache-2.0
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urwid

# littlechat

## About

A little chatroom run in console, write in python base
on [`urwid`](https://github.com/urwid/urwid) and `UDP`,
only support Linux, OSX, Cygwin or other unix-like OS, not support Windows

## Chat example

* Chinese character example
  ![chat example](https://github.com/yujun2647/littlechat/raw/main/imgs/client_page.png)
* emoji example
  ![emoji example](https://github.com/yujun2647/littlechat/raw/main/imgs/client_page_emoji.png)

## Quick Start

### Install

#### From repository

* From github

```shell
pip install git+https://github.com/yujun2647/littlechat.git
```

* From gitee

```shell
pip install git+https://gitee.com/walkerjun/littlechat.git
```

#### From Pypi

```shell
pip install littlechat
```

### Usage

#### Start server

* start server at port: 5000

```shell
lchat -t server -sp 5000
```

#### Connect with client

* connect server above

```shell
lchat -sp 5000
```

## Hotkeys supports

| Name            | Use                                       | 
|-----------------|-------------------------------------------|
| `Alt` + `Enter` | force to start a new line at input box    |
| `Alt` + `e`     | open emoji box                            |
| `Alt` + `l`     | keep focus in the edit box (Author needs) |
