Metadata-Version: 2.1
Name: teev
Version: 0.0.1.dev1
Summary: Asynchronous Telegram Bot Framework.
Home-page: http://teev.startech.live
Author: Stepan Starovoitov
Author-email: stepan@startech.live
License: BSD
Project-URL: Documentation, http://teev.startech.live
Project-URL: Code, https://github.com/startech-live/teev
Project-URL: Issue tracker, https://github.com/startech-live/teev/issues
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
Requires-Dist: aiogram
Requires-Dist: flask
Provides-Extra: dev
Requires-Dist: alabaster ; extra == 'dev'
Requires-Dist: doc8 ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: testfixtures ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: alabaster ; extra == 'docs'
Requires-Dist: doc8 ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: testfixtures ; extra == 'tests'
Requires-Dist: tox ; extra == 'tests'

teev
====
.. image:: https://img.shields.io/badge/test-pass-00d200.svg
    :target: nono

.. image:: https://img.shields.io/badge/build-pass-00d200.svg
    :target: nono

.. image:: https://img.shields.io/badge/license-BSD-blue.svg?style=flat-square
    :target: https://en.wikipedia.org/wiki/BSD_License

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black

Teev is an open source asynchronous Python telegram bots module designed \
for humans mainly inspired by `Eve <https://github.com/pyeve/eve>`_ and made as a wrapper around
`aiogram <https://github.com/aiogram/aiogram>`_ module.
It allows setting up telegram bot using settings file, making its logic more readable
and easy to upgrade.

Teev is Simple
--------------
.. code-block:: python

    from teev import Teev

    app = Teev()
    app.run()

Bot is now alive and ready to process messages.
You need to provide proper telegram token in settings.py file.

.. code-block:: python

    TOKEN = ""

    COMMANDS = [
        ["/start", "Say Love"]
    ]

    SCHEME = {
        "/start": {
            "text": "I love Teev!"
        }
    }


You can see `examples <https://github.com/startech-live/teev/examples>`_ to find out more.

`Check out the teev Website <https://teev.startech.live/>`_ (Not yet available)

Features
--------
* Full support of all aiogram methods.
* Keyboard made in one instruction.
* Text logic made simple in scheme.
* Statuses logic to handle user answers.

To Do
-----
* Native Mongodb support.
* Buffer responses.
* Different message send types.

License
-------
teev is a `Stepan Starovoitov`_ open source project,
distributed under the `BSD license
<https://github.com/startech-live/teev/blob/master/LICENSE>`_.

.. _`Stepan Starovoitov`: https://starovoitov.startech.live


