Initial commit

Author: luk3yx

.github/workflows/pythonpublish.yml

@@ -0,0 +1,28 @@
+name: Upload Python Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine mypy requests types-requests
+    - name: Run mypy
+      run: mypy miniirc_matrix.py
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

.gitignore

@@ -0,0 +1,32 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Mypy
+.mypy_cache/

LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright © 2021 by luk3yx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+# 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`.