Metadata-Version: 2.1
Name: miniirc_matrix
Version: 0.0.2
Summary: A Matrix wrapper for miniirc.
Home-page: UNKNOWN
Author: luk3yx
License: MIT
Description: # miniirc_matrix
        
        [![Available on PyPI.](https://img.shields.io/pypi/v/miniirc-matrix.svg)](https://pypi.org/project/miniirc-matrix/)
        
        A wrapper for miniirc ([GitHub], [GitLab]) to allow bots or clients made in
        miniirc to join Matrix rooms with minimal code changes. Requires Python 3.8 or
        later.
        
        ## How to use
        
        To use miniirc_matrix, you already need to know how to use miniirc ([GitHub],
        [GitLab]). Instead of creating a `miniirc.IRC` object, however, you need to
        use `miniirc_matrix.Matrix`.
        
         - `ip` is the address of the Matrix homeserver.
         - `port` is optional and will default to 443 if not specified and if `ip`
            doesn't have a port.
         - There is a `token` keyword argument that must contain the Matrix token.
        
        Example: `irc = miniirc_matrix.Matrix('matrix.org:443', token='my_token')`
        
        Channel names are currently room IDs and start with `!`. You may use a Matrix
        room alias (for example `#matrix:matrix.org`) in place of a room ID, however.
        Hopefully one day alias support will be added so that channel names can
        correspond to alias names.
        
        Formatting is translated to and from Matrix's custom HTML format. Note that
        colours are not supported in incoming messages, although they mostly work in
        outgoing messages.
        
        [GitHub]: https://github.com/luk3yx/miniirc
        [GitLab]: https://gitlab.com/luk3yx/miniirc
        
        ## Obtaining a token
        
        You must obtain a token to use miniirc_matrix. You can do this with
        `miniirc_matrix.login(homeserver_address, username, password)`.
        
        There is also `miniirc_matrix.logout(homeserver_address, token)` and
        `miniirc_matrix.logout_all(homeserver_address, username, password)` if you wish
        to invalidate your token.
        
        ## Supported commands
        
        The `PRIVMSG` (including `CTCP ACTION`/`irc.me`), `NOTICE`, `TAGMSG`, `JOIN`,
        and `PART` commands should work as expected.
        
        Note that events sent before the client connects to Matrix are ignored. Your
        system must have an accurate clock for this to work properly.
        
        ## Installation
        
        You can install `miniirc_matrix` with `pip install miniirc_matrix`.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.8
Description-Content-Type: text/markdown
