semvec/pypi-packages huggingface dataset:
hipchat-notifications 0.4.1
Basic functions for sending notifications via HipChat API (v2)
License: MIT

.. image:: https://travis-ci.org/yunojuno/hipchat-notifications.svg?branch=master
    :target: https://travis-ci.org/yunojuno/hipchat-notifications

.. image:: https://badge.fury.io/py/hipchat-notifications.svg
    :target: https://badge.fury.io/py/hipchat-notifications

HipChat Notifications
=====================

This is a very simple library for sending user and room notifications to HipChat via their v2 API.

It contains a couple of generic functions for sending messages
to rooms and users within HipChat.

.. code:: python

    >>> hipchat.notify_room('Customer Service', 'This is a message')
    >>> hipchat.notify_user('hugo', 'Hello, Hugo')

It includes some colour-specific helpers for room-only notifications:

.. code:: python

    >>> hipchat.green('Customer service', 'This is a green message')

The functions support the ``message_format`` values:

    **html** - Message is rendered as HTML and receives no special treatment. Must be valid HTML and entities must be escaped (e.g.: '&amp;' instead of '&'). May contain basic tags: a, b, i, strong, em, br, img, pre, code, lists, tables.

    **text** - Message is treated just like a message sent by a user. Can include @mentions, emoticons, pastes, and auto-detected URLs (Twitter, YouTube, images, etc).

    >>> hipchat.green('Customer service', 'Hello @fred', message_format='text')

The ``color``, ``notify`` and ``from`` parameters are also supported (``from`` is passed as a kwarg called ``label``):

.. code:: python

    >>> notify_room(
    ...     'customer service',
    ...     'Hey there @Tony',
    ...     color='red',
    ...     label='baz',
    ...     notify=True,
    ...     message_format='text'
    ... )

Settings
--------

The following settings are read from the environment using ``os.getenv``

* ``HIPCHAT_API_TOKEN``

A valid API access token. See the `API docs <https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-access-tokens>`_ for details on how to
generate a token. (Hint: the easiest way is to use a "Personal access token"
generated through the site.)

If there is no token set in the environment the notifications will be logged
using the 'hipchat' logger, with a DEBUG level.

Installation
------------

The library is available on PyPI as 'hipchat_notifications'.

Tests
-----

The tests can be run using ``tox``:

.. code:: shell

    $ tox


Contributors
------------

* Hugo Rodger-Brown - @hugorodgerbrown
* Roberto Salgado - @droberin
rapydo-controller 0.4.3
Do development and deploy with the RAPyDo framework
License: MIT
Requires Python: >=3.4

RAPyDo controller
=================

(a.k.a. ``do``)

Do things with RAPyDo ecosystem

--------------

The project
-----------

Welcome to our new ``RAPyDo`` framework.

This project is based on Flask and aims at making easy for a web
developer to write Python code on his own HTTP-API;

Forget about the difficult setup of the server, authentication, plugin
of services, testing connections, documenting your endpoints and
injecting components into Flask.

Requirements
------------

This component is written and tested with ``Python 3.4+``. All bash
commands below are using ``pip3`` as a reference for ``pip`` installed
with Python3.

Before starting you have to make sure to install:

-  python 3
-  pip 3
-  docker
-  git

Install the controller
----------------------

Use the official python package manager:

.. code:: bash

    $ pip3 install --upgrade rapydo-controller

Use it on your REST API project
-------------------------------

This controller works only on a `RAPyDo
compliant <https://github.com/rapydo>`__ repository. Clone or fork the
core framework to start your project:

.. code:: bash

    $ git clone https://github.com/rapydo/core.git

    $ rapydo check
    $ rapydo -h

Developers
----------

Do you want to partecipate?

Well, you are very welcome here! ``^_^``

Become a developer
~~~~~~~~~~~~~~~~~~

Clone and install in 'development' mode:

.. code:: bash

    $ git clone https://github.com/rapydo/do.git
    $ pip3 install --no-cache-dir --upgrade --editable .

Now you can start developing your patch.

Release a new version
~~~~~~~~~~~~~~~~~~~~~

1. change version inside the file ``rapydo/do/__init__.py``
2. build and publish in testing

The latter can be done with the command:

.. code:: bash

    $ pip3 install -r dev-requirements.txt
    $ ./make

Note! The last command expects you to

-  being registered on PyPi
-  have a ``~/.pypirc`` file configured
-  know what you're doing ``:D``