Metadata-Version: 2.0
Name: ehforwarderbot
Version: 2.0.0a1.dev2
Summary: An extensible message tunneling chat bot framework.
Home-page: https://github.com/blueset/ehforwarderbot
Author: Eana Hufwe
Author-email: ilove@1a23.com
License: GPLv3
Keywords: EFB,EH Forwarder Bot,Chat tunneling,IM,messaging,
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Utilities
Requires-Python: >=3.5
Requires-Dist: PyYaml

EH Forwarder Bot
================

.. image:: https://img.shields.io/badge/Python->%3D%203.5-blue.svg
   :alt: Python >= 3.5
   :target: https://www.python.org/
.. image:: https://img.shields.io/gitter/room/blueset/ehForwarderBot.svg
   :alt: Gitter
   :target: https://gitter.im/blueset/ehForwarderBot
.. image:: https://img.shields.io/badge/Chat-on%20Telegram-blue.svg
   :alt: Telegram support group
   :target: https://telegram.me/efbsupport
.. image:: https://readthedocs.org/projects/ehforwarderbot/badge/?version=latest
   :alt: Documentation
   :target: https://ehforwarderbot.readthedocs.io/en/latest/
.. image:: https://img.shields.io/github/tag/blueset/ehforwarderbot.svg
   :alt: tag release
   :target: https://github.com/blueset/ehForwarderBot/releases
.. image:: https://img.shields.io/codacy/grade/3b2555f9134844e3b01b00700bc43eeb.svg
   :alt: Codacy grade
   :target: https://www.codacy.com/app/blueset/ehForwarderBot


.. image:: https://images.1a23.com/di/XOEE/EFB_v2.png
   :alt: Banner


*Codename* **EH Forwarder Bot** (EFB) is an extensible
chat tunnel framework which allows users to contact
people from other chat platforms, and ultimately remotely
control their accounts in other platforms.

v2.0 Alpha release
------------------
This is an alpha release of EFB version 2 for preview only.
Documentation is yet incomplete. Framework API may subject to
change.

`Documentation`_.

Getting Started
---------------

1. Install the framework::

    pip3 install ehforwarderbot

2. `Install and enable channels`_ from the `channels repository`_.

3. Launch EFB::

    $ ehforwarderbot

Feel like contributing?
-----------------------

Everyone is welcomed to raise an issue or submit a pull request,
just remember to read through and follow the
contribution guideline before you do so.

Related articles
----------------

* `Idea: Group Chat Tunneling (Sync) with EH Forwarder Bot`__

.. __: https://blog.1a23.com/2017/01/28/Idea-Group-Chat-Tunneling-Sync-with-EH-Forwarder-Bot/

License
-------

EFB framework is licensed under `GNU General Public License 3.0`_::

    EH Forwarder Bot: An extensible chat tunneling bot framework.
    Copyright (C) 2016 Eana Hufwe
    All rights reserved.

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

.. _Install and enable channels: https://ehforwarderbot.readthedocs.io/en/efb2/getting-started.html
.. _channels repository: https://github.com/blueset/ehForwarderBot/wiki/Channels-Repository
.. _Documentation: https://ehforwarderbot.readthedocs.io/en/efb2/
.. _GNU General Public License 3.0: https://www.gnu.org/licenses/gpl-3.0.txt


