Metadata-Version: 1.0
Name: rocketchat_API
Version: 0.6.3
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://rocket.chat/docs/developer-guides/rest-api)
        
        ### Installation
        - From pypi:
        `pip3 install rocketchat_API`
        - From GitHub:
        Clone our repository and `python3 setup.py install`
        
        ### Requirements
        - [requests](https://github.com/kennethreitz/requests)==2.13.0
        
        ### Usage
        ```
        from pprint import pprint
        from rocketchat_API.rocketchat import RocketChat
        
        proxyDict = {
                      "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=proxyDict)
        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.
        
        ### 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.
        
        *note*: Library updated to work with Rocket.Chat >= 0.58.0
        
        ### Tests
        We started writing tests :D 
        
        Tests run on a Rocket.Chat Docker container so install Docker and run `tests/run_rocketchat.sh` and whe Rocket.Chat is active run `py.test tests/tests.py`. After testing, remember to stop and remove containers run `tests/stop_rocketchat.sh`
        
        We are on an early stage testing so must of the code is still untested. There is an open issue on this and help is wanted ;)
        
        ### 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). We hang out [here](https://demo.rocket.chat/channel/python_rocketchat_api) if you want to talk.
        
Platform: UNKNOWN
