Metadata-Version: 2.1
Name: rocketchat_API
Version: 1.16.0
Summary: Python API wrapper for Rocket.Chat
Home-page: https://github.com/jadolg/rocketchat_API
Author: Jorge Alberto Díaz Orozco
Author-email: diazorozcoj@gmail.com
License: MIT
Description: ## rocketchat_API
        Python API wrapper for [Rocket.Chat](https://docs.rocket.chat/api/rest-api)
        
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/fff725d9a0974c6597c2dd007daaa86e)](https://www.codacy.com/app/jadolg/rocketchat_API?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=jadolg/rocketchat_API&amp;utm_campaign=Badge_Grade) ![Test and publish](https://github.com/jadolg/rocketchat_API/workflows/Test%20and%20publish/badge.svg?branch=master) [![codecov](https://codecov.io/gh/jadolg/rocketchat_API/branch/master/graph/badge.svg)](https://codecov.io/gh/jadolg/rocketchat_API) ![PyPI](https://img.shields.io/pypi/v/rocketchat_API.svg) ![](https://img.shields.io/pypi/dm/rocketchat-api.svg)
        
        ### Installation
        - From pypi:
        `pip3 install rocketchat_API`
        - From GitHub:
        Clone our repository and `python3 setup.py install`
        
        ### Requirements
        - [requests](https://github.com/kennethreitz/requests)
        
        ### Usage
        ```python
        from pprint import pprint
        from rocketchat_API.rocketchat import RocketChat
        
        proxy_dict = {
            "http"  : "http://127.0.0.1:3128",
            "https" : "https://127.0.0.1:3128",
        }
        
        rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat', proxies=proxy_dict)
        pprint(rocket.me().json())
        pprint(rocket.channels_list().json())
        pprint(rocket.chat_post_message('good news everyone!', channel='GENERAL', alias='Farnsworth').json())
        pprint(rocket.channels_history('GENERAL', count=5).json())
        ```
        
        *note*: every method returns a [requests](https://github.com/kennethreitz/requests) Response object.
        
        #### Connection pooling
        If you are going to make a couple of request, you can user connection pooling provided by `requests`. This will save significant time by avoiding re-negotiation of TLS (SSL) with the chat server on each call.
        
        ```python
        from requests import sessions
        from pprint import pprint
        from rocketchat_API.rocketchat import RocketChat
        
        with sessions.Session() as session:
            rocket = RocketChat('user', 'pass', server_url='https://demo.rocket.chat', session=session)
            pprint(rocket.me().json())
            pprint(rocket.channels_list().json())
            pprint(rocket.chat_post_message('good news everyone!', channel='GENERAL', alias='Farnsworth').json())
            pprint(rocket.channels_history('GENERAL', count=5).json())
        ```
         
        
        ### Method parameters
        Only required parameters are explicit on the RocketChat class but you can still use all other parameters. For a detailed parameters list check the [Rocket chat API](https://rocket.chat/docs/developer-guides/rest-api/)
        
        ### API coverage
        Most of the API methods are already implemented. If you are interested in a specific call just open an issue or open a pull request.
        
        ### Tests
        We are actively testing :) 
        
        Tests run on a Rocket.Chat Docker container so install Docker and docker-compose. To start test server do `docker-compose -f docker-compose-test-server.yml up` and to take test server down `docker-compose -f docker-compose-test-server.yml down`
        
        ### Contributing
        You can contribute by doing Pull Requests. (It may take a while to merge your code but if it's good it will be merged). Please, try to implement tests for all your code and use a PEP8 compliant code style.
        
        Reporting bugs and asking for features is also contributing ;) Feel free to help us grow by registering issues.
        
        We hang out [here](https://demo.rocket.chat/channel/python_rocketchat_api) if you want to talk. 
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
