Metadata-Version: 2.1
Name: puzh
Version: 1.1.0
Summary: Easily send messages to Telegram
Home-page: https://github.com/puzh/puzh.py
Author: lmittmann
License: MIT
Keywords: puzh,push,telegram,bot,notification
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3
Requires-Dist: requests (>=2.4.2)

puzh
====

|Build Status| |PyPI version|

**puzh** is a simple wrapper package for the `puzh.it <https://puzh.it>`__ api. It supports
**python 3.x**.

You can easily push messages to the telegram `@puzhbot <https://t.me/puzhbot>`__.


Install
-------

::

    $ pip install puzh


Usage
-----

.. code:: py

    # Simple usage
    import puzh

    puzh.it('*Hi* ✌', token='secret_token')


    # Advanced usage
    from puzh.puzh import Puzh

    puzh = Puzh('secret_token')
    puzh.it('*Hi* ✌')


API
---

puzh.\ ``it(*objects, token=None, silent=False, sep=' ')``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Push a message to the telegram `@puzhbot <https://t.me/puzhbot>`__. Using ``silent=True`` will send
the message silently. Users will receive a notification without sound.

Messages can be formatted using `Markdown <https://core.telegram.org/bots/api#markdown-style>`__.
Multiple arguments will be separated by ``sep``, a space by default.

The method is executed asynchronously, if it fails, it will swallow any exception silently.


.. |Build Status| image:: https://travis-ci.org/puzh/puzh.py.svg?branch=master
    :target: https://travis-ci.org/puzh/puzh.py
.. |PyPI version| image:: https://img.shields.io/pypi/v/puzh.svg
    :target: https://pypi.org/project/puzh


