معرفی شرکت ها
Weitersager-0.9
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
A proxy to forward messages received via HTTP to to IRC
| ویژگی | مقدار |
|---|---|
| سیستم عامل | OS Independent |
| نام فایل | Weitersager-0.9 |
| نام | Weitersager |
| نسخه کتابخانه | 0.9 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Jochen Kupperschmidt |
| ایمیل نویسنده | homework@nwsnet.de |
| آدرس صفحه اصلی | http://homework.nwsnet.de/releases/1cda/#weitersager |
| آدرس اینترنتی | https://pypi.org/project/Weitersager/ |
| مجوز | MIT |
===========
Weitersager
===========
.. image:: https://raw.githubusercontent.com/homeworkprod/weitersager/main/assets/weitersager_logo.svg
:alt: Weitersager logo
:height: 200
:width: 200
A proxy that receives text messages via JSON over HTTP and shows them on
IRC.
Weitersager emerged from syslog2IRC_ and offers a generic, not
syslog-specific input interface.
:Copyright: 2007-2022 `Jochen Kupperschmidt <http://homework.nwsnet.de/>`_
:License: MIT, see LICENSE for details.
.. _syslog2IRC: http://homework.nwsnet.de/releases/c474/#syslog2irc
Code Status
===========
|badge_github-actions_test|
|badge_scrutinizer-ci_coverage|
|badge_scrutinizer-ci_quality-score|
|badge_code-climate_maintainability|
.. |badge_github-actions_test| image:: https://github.com/homeworkprod/weitersager/actions/workflows/test.yml/badge.svg
:alt: Testing Status
:target: https://github.com/homeworkprod/weitersager/actions/workflows/test.yml
.. |badge_scrutinizer-ci_coverage| image:: https://scrutinizer-ci.com/g/homeworkprod/weitersager/badges/coverage.png?b=main
:alt: Scrutinizer Code Coverage
:target: https://scrutinizer-ci.com/g/homeworkprod/weitersager/?branch=main
.. |badge_scrutinizer-ci_quality-score| image:: https://scrutinizer-ci.com/g/homeworkprod/weitersager/badges/quality-score.png?b=main
:alt: Scrutinizer Code Quality
:target: https://scrutinizer-ci.com/g/homeworkprod/weitersager/?branch=main
.. |badge_code-climate_maintainability| image:: https://api.codeclimate.com/v1/badges/f45b29ee321c1920a85c/maintainability
:alt: Code Climate
:target: https://codeclimate.com/github/homeworkprod/weitersager
Requirements
============
- Python 3.7+
- Dependencies: blinker_, irc_, rtoml_, Werkzeug_
.. _blinker: http://pythonhosted.org/blinker/
.. _irc: https://bitbucket.org/jaraco/irc
.. _rtoml: https://github.com/samuelcolvin/rtoml
.. _Werkzeug: https://palletsprojects.com/p/werkzeug/
Installation
============
Weitersager and its dependencies can be installed via pip_:
.. code:: sh
$ pip install weitersager
To update an installed copy of Weitersager to the most recent release:
.. code:: sh
$ pip install -U weitersager
.. _pip: http://www.pip-installer.org/
Usage
=====
Start Weitersager with a configuration file:
.. code:: sh
$ weitersager config.toml
Configuration
-------------
Configuration is done as a file in TOML_ format.
A very basic configuration is very short. By default, the HTTP server
runs on port 8080 on ``localhost``. All that needs to be specified are
the IRC server host, bot nickname, and channel(s) to join.
.. code:: toml
[irc.server]
host = "irc.server.example"
[irc.bot]
nickname = "Weitersager"
[[irc.channels]]
name = "#lobby"
A lot more can be configured, though:
.. code:: toml
log_level = "debug" # optional; default: `"debug"`
[http]
host = "127.0.0.1" # optional; default: `"127.0.0.1"`
port = 8080 # optional; default: `8080`
api_tokens = [ "123xyz" ] # optional; default: `[]`
[irc.server]
host = "irc.server.example"
port = 6667 # optional; default: `6667`
ssl = false # optional; default: `false`
password = "secret" # optional; default: no password
rate_limit = 0.5 # optional; limit of messages
# per second; default: no limit
[irc.bot]
nickname = "Weitersager"
realname = "Weitersager" # optional; default: `"Weitersager"`
[irc]
commands = [ # optional; default: `[]`
"MODE Weitersager +i",
]
[[irc.channels]]
name = "#party"
[[irc.channels]]
name = "#secretlab"
password = "555-secret"
.. _TOML: https://toml.io/
IRC Dummy Mode
--------------
If no value for ``irc.server.host`` is set, Weitersager will not attempt
to connect to an IRC server and start in IRC dummy mode. It will still
accept messages, but it will write them to STDOUT. This can be useful
for testing.
HTTP API
--------
To send messages to IRC, send an HTTP POST request to URL path ``/`` at
the address and port the application is listening on.
The body has to be in JSON_ format and contain two keys, ``channel`` and
``text``, with string values:
.. code:: json
{
"channel": "#party",
"text": "Oh yeah!"
}
.. _JSON: https://www.json.org/
Example HTTPie_ call to send a message to Weitersager on localhost, port
8080:
.. code:: sh
$ http --json post :8080 channel='#party' text='Oh yeah!'
.. _HTTPie: https://httpie.org/
Authorization
~~~~~~~~~~~~~
To protect the HTTP API a bit, requests can be required to include an
authorization header with a valid token to be accepted.
The authorization check becomes active if at least one API token is
configured. A command line tool is provided to generate secure tokens:
.. code:: sh
$ weitersager-token
e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM
Multiple API tokens can be configured so that each legitimate client
can be given its own token which can than be revoked (by removing it
from the configuration, and restarting) individually.
Header format:
.. code:: http
Authorization: Token <a token of your choosing>
Example authorization header:
.. code:: http
Authorization: Token e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM
Example HTTPie_ call with authorization header:
.. code:: sh
$ http --json post :8080 Authorization:'Token e72CbijlYLqjaRIv0uMNBpgZKl397FEp-Y8PNEXn5vM' channel='#party' text='Oh yeah!'
Note that Weitersager itself only uses unencrypted HTTP, so the API
tokens are passed in the clear. That might suffice if you run it on the
same host as the HTTP clients. Otherwise you might want to look into
hiding Weitersager behind a web server or proxy that can add TLS
encryption.
Channel Tokens
~~~~~~~~~~~~~~
As of version 0.9, Weitersager supports an alternative HTTP endpoint
using a secret token as part of the URL instead of an authorization
header. This makes it a bit easier to use for clients.
Each secret token is mapped to a channel, so each URL already implicitly
(though intransparently, for the caller) defines the channel the
submitted text should be sent to.
This pattern is also used by popular messaging services like Slack_ and
Discord_ for incoming webhooks.
To expose a channel via this endpoint, just add one or more tokens to it:
.. code:: toml
[[irc.channels]]
name = "#secretlab"
tokens = [
"A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY",
"JMApghB7wkHCtw0TcQ1Bu7zY-wG03os61bBDXfAZ4Yc",
]
To generate a token, use the ``weitersager-token`` command. Feel free to
use a separate token for each client/app that calls the endpoint to be
able to revoke tokens separately (by simply removing them from the
configuration) if need be.
As a result, these endpoints become available:
- ``/ct/A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY``
- ``/ct/JMApghB7wkHCtw0TcQ1Bu7zY-wG03os61bBDXfAZ4Yc``
Call them like this (note that neither the ``Authorization`` header nor
the ``channel`` key in the payload are specified):
.. code:: sh
$ http --json post :8080/ct/A2x23NmcdQgWJ8-5PivbvPX4KmdL9oa7Sy8Jj_9ldoY text='Oh yeah!'
.. _Slack: https://slack.com/
.. _Discord: https://discord.com/
Run in a Docker Container
=========================
Build a container image, tagged ``weitersager``:
.. code:: sh
$ docker build -t weitersager .
Start the container, using configuration file
``config_example_docker.toml`` (which should expose Weitersager *inside
the container* on host ``0.0.0.0`` and port 8080), exposing Weitersager
*on the Docker host* on host ``127.0.0.1`` and port 9000:
.. code:: sh
$ docker run -d \
--mount type=bind,source="$(pwd)"/config_example_docker.toml,destination=/app/config.toml,readonly \
-p 127.0.0.1:9000:8080 \
weitersager
The local configuration file is made available to the container through
a `bind mount`_.
.. _bind mount: https://docs.docker.com/storage/bind-mounts/
Using Docker Compose
--------------------
A configuration file for Docker Compose, ``docker-compose.yaml``, is
also available. Adjust as necessary, then run Weitersager in a container
using:
.. code:: sh
$ docker-compose up --detach
Implementation Details
======================
A Note on Threads
-----------------
This tool uses threads. Besides the main thread, there are two
additional threads: one for the message receiver and one for the IRC
bot. Both are configured to be daemon threads.
The dummy bot, on the other hand, does not run in a thread.
A Python application exits if no more non-daemon threads are running.
The user has to manually interrupt the application to exit.
For details, see the documentation on the ``threading`` module that is
part of Python's standard library.
Changelog
=========
0.9 (2022-05-07)
----------------
- Introduced alternative endpoints using secret "channel tokens" as part
of the URL.
0.8.1 (2022-05-05)
------------------
- Fixed Werkzeug dependency missing in ``setup.cfg``.
0.8 (2022-05-04)
----------------
- Recreated HTTP server as a WSGI application, built with Werkzeug and
served by wsgiref.
- Return status code 415 ("Unsupported Media Type") if request content
type is not ``application/json``.
0.7.2 (2022-05-03)
------------------
- Return status code 404 ("Not Found") on requests to any path other
than ``/``.
- Added Docker-specific configuration file example.
- Added configuration file for Docker Compose.
0.7.1 (2022-04-27)
------------------
- Changed application path in Docker container from ``/home/user`` to
``/app``. This is relevant when mounting the configuration file into the
container.
0.7 (2022-04-26)
----------------
- Added support for Python 3.10.
- Expect config file to be mounted into Docker container.
- Use non-inline array of tables for IRC channels in TOML configuration
examples.
- Reintroduce announcer as abstraction.
- Updated irc version to 20.0.0 (from 19.0.1).
- Updated rtoml to 0.7.1 (from 0.6.1).
0.6 (2021-05-07)
----------------
- Switched to using Python's logging mechanism directly, with different
log levels. Removed function ``util.log``.
- Made the application's log level configurable.
- Enabled threading for the HTTP server to reduce blocking.
- Introduced an internal queue to decouple reception of HTTP requests
from announcing messages on IRC.
- Added support for custom IRC commands to send after connecting
(authentication, cloaking, flood protection, etc.).
- Updated rtoml to 0.6.1 (from 0.5.0).
0.5 (2021-02-07)
----------------
- Added support for Python 3.9.
- Added support for SSL connections to IRC servers.
- Changed prefix of authorization header value from ``WTRSGR`` to less
awkward ``Token``.
- Removed handler to shut down Weitersager via private IRC message. It
doesn't provide enough relevant value.
- Added command line option ``--version`` to show Weitersager's version.
- Updated rtoml to 0.5.0 (from 0.4.0).
- Include tests and other useful files in source distribution archive.
0.4 (2020-10-11)
----------------
- Added command line tool to generate secure tokens (which can be used as
API tokens).
- Allow to configure a rate limit for the IRC connection, i.e. the maximum
number of messages per second to send. This can prevent the bot from
getting kicked (or even banned) from a channel because of flooding.
- Added exemplary Dockerfile.
- Added type hints.
- Updated rtoml to 0.4.0 (from 0.3.0).
0.3 (2020-09-16)
----------------
- Introduced TOML-based configuration file.
- Added dependency on rtoml 0.3.0.
- Moved IRC channel configuration from Python code to configuration
file.
- Moved IRC server and bot name configuration from command line
arguments to configuration file.
- Moved HTTP receiver configuration from command line arguments to
configuration file.
- Made configuration filename a required command line argument.
- Turned the stray run script into an actual entry point console script.
- Added support for IRC server password.
- Added optional HTTP authorization via API tokens.
0.2 (2020-09-13)
----------------
- Raised minimum Python version to 3.7.
- HTTP protocol was changed:
- Only a single channel is allowed per message.
- Response code for successful submit was changed from 200 (OK) to
more appropriate 202 (Accepted).
- Divided code base into separate modules in a package.
- Switch to a ``src/`` layout.
- Dependency versions have been pinned.
- Updated irc version to 19.0.1 (from 12.3).
- Updated blinker to 1.4 (from 1.3).
- Do not use tox for tests anymore.
- Use ``dataclass`` instead of ``namedtuple`` for value objects.
- Allowed for custom shutdown predicate.
0.1 (2015-04-24)
----------------
- First official release (at LANresort 2015)
نیازمندی
| مقدار | نام |
|---|---|
| ==1.4 | blinker |
| ==20.0.0 | irc |
| ==0.7.1 | rtoml |
| ==2.1.2 | werkzeug |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl Weitersager-0.9:
pip install Weitersager-0.9.whl
نصب پکیج tar.gz Weitersager-0.9:
pip install Weitersager-0.9.tar.gz