Metadata-Version: 2.4
Name: ellinetircd
Version: 1.0.0
Summary: ElliNetIRCd - an asynchronous IRC server
Home-page: https://github.com/ElliNet13/ElliNetIRCd
Download-URL: https://pypi.org/project/ellinetircd/
Author: ElliNet13
Author-email: your@email.com
License: MIT
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: trio
Dynamic: download-url
Dynamic: license-file

ellinetircd
=======

A python asynchronous IRC server based on aioirc.

### Installation and Usage

Download and install the latest stable version using pip.
Windows users might replace `python3` by `py`.
```bash
python3 -m pip install ellinetircd
```

Then run the server:
```bash
HOST=0.0.0.0 LOGLEVEL=INFO python3 -m ellinetircd
```
If you are using powershell you can use the following command:
```powershell
$env:HOST="0.0.0.0"
$env:LOGLEVEL="INFO"
python -m ellinetircd
```

The configuration is done via environment variables, see `--help`:

    optional arguments:
      -h, --help     show this help message and exit
      -V, --version  show program's version number and exit

    environment variables:
      HOST           public domain name (default: julien-UX410UAR)
      ADDR           ip address to bind (default: 127.0.1.1)
      PORT           port to bind (default: 6667)
      PASS           server password (default: )
      TIMEOUT        kick inactive users after x seconds (default: 60)
      PING_TIMEOUT   PING inactive users x seconds before timeout (default: 5)
      LOGLEVEL       logging verbosity (default: WARNING)
