Metadata-Version: 2.1
Name: fbbotw
Version: 2.1.6
Summary: Python/Django Wrapper for Facebook Messenger Bot Platform.
Home-page: https://github.com/JoabMendes/fbbotw
Author: Joabe Mendes
Author-email: joabe.mdl@gmail.com
License: MIT
Description: # FBBOTW: A [Facebook Messenger](https://developers.facebook.com/products/messenger/) Platform API Wrapper
        
        [![Build Status](https://travis-ci.org/JoabMendes/fbbotw.svg?branch=master)](https://travis-ci.org/JoabMendes/fbbotw) [![Documentation Status](https://readthedocs.org/projects/fbbotw/badge/?version=latest)](http://fbbotw.readthedocs.io) [![PyPI](https://img.shields.io/pypi/v/fbbotw.svg)](https://pypi.python.org/pypi?name=fbbotw&:action=display) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/hyperium/hyper/master/LICENSE) 
        
        
        This wrapper makes it simpler to user the *Facebook Messenger platform*  wrapping the endpoints as functions.
        
        For exemple, to send a text message to the user you can easily do:
        
        ```python
        from fbbotw import fbbotw
        # ...
        
        user_fbid = "<user fb id>"
        my_message = "Hello World"
        
        fbbotw.post_text_message(fbid=user_fbid, message=my_message)
        # The user with the specified fbid will receive the text 'Hello World'
        
        ```
        
        This is much less code than the traditional way to call the `Send API` and send a text. Using `requests` and `json` you probably would do like this:
        
        ```python
          fbid = "<user psid>"
          message = "Hello World"
          url = 'https://graph.facebook.com/v2.6/me/messages?access_token={0}'
          url = url.format(PAGE_ACCESS_TOKEN)
          header = {"Content-Type": "application/json"}
          payload = {}
          payload['recipient'] = {'id': fbid}
          payload['message'] = {'text': message}
          data = json.dumps(payload)
          response = requests.post(url=url, headers=header, data=data)
        ```
        
        Learn more about the fbbotw methods by reading the [DOCS](http://fbbotw.readthedocs.io/en/latest/)
        
        ## Get Started
        
        ### 1- Install
        
        ```bash
        pip install fbbotw
        ```
        
        ### 2 - Configure it
        
        The only configuration needed is to set the `PAGE_ACCESS_TOKEN` with
        the value you got from the [facebook app dashboard](https://developers.facebook.com/docs/messenger-platform/guides/setup#page_access_token). If you are using Django, create the variable in your `settings.py`. If not, define the variable in your enviroment:
        
        #### 2.1 - Django
        
        1 - In your `settings.py` define the variable `PAGE_ACCESS_TOKEN` that was 
        generated on the app configuration from facebook.
        
        ```python
        #settings.py
        PAGE_ACCESS_TOKEN = "<your access token>"
        ```
        
        #### 2.2 - Not Django
        
        Create an **os environment** variable called `PAGE_ACCESS_TOKEN`:
        
        ```bash
        export PAGE_ACCESS_TOKEN='<your access token>'
        ```
        
        ### 3 - Import and Use it
        
        After setting the access token, just import and use `fbbotw` methods:
        
        ```python
        from fbbotw import fbbotw
        
        fbbotw.post_sender_action(fbid="<user psid>", sender_action="typing_on")
        
        ```
        
        See the documentation to learn about the methods provided by the package.
        
        # Documentation
        
        - [Read the Docs](http://fbbotw.readthedocs.io/en/latest/)
        
        # Current wrapper covering for the [Menssenger Platform 2.0](https://developers.facebook.com/docs/messenger-platform/product-overview)
        
        
        - [ ] Send API
          - [x] Content Types
            - [x] [Text messages](https://developers.facebook.com/docs/messenger-platform/send-api-reference/text-message)
            - [x] [Audio attachment](https://developers.facebook.com/docs/messenger-platform/send-api-reference/audio-attachment)
            - [x] [Image attachment](https://developers.facebook.com/docs/messenger-platform/send-api-reference/image-attachment)
            - [x] [Video attachment](https://developers.facebook.com/docs/messenger-platform/send-api-reference/video-attachment)
            - [x] [File attachment](https://developers.facebook.com/docs/messenger-platform/send-api-reference/file-attachment)
          - [x] [Quick Replies](https://developers.facebook.com/docs/messenger-platform/send-api-reference/quick-replies)
          - [x] [Sender Actions](https://developers.facebook.com/docs/messenger-platform/send-api-reference/sender-actions)
          - [x] [Attachment Upload API](https://developers.facebook.com/docs/messenger-platform/send-api-reference/attachment-upload)
          - [ ] Templates
            - [x] [Button Template](https://developers.facebook.com/docs/messenger-platform/send-api-reference/button-template)
            - [x] [Generic Template](https://developers.facebook.com/docs/messenger-platform/send-api-reference/generic-template)
            - [x] [List Template](https://developers.facebook.com/docs/messenger-platform/send-api-reference/list-template)
            - [x] [Receipt Template](https://developers.facebook.com/docs/messenger-platform/send-api-reference/receipt-template)
            - [x] [Media Template](https://developers.facebook.com/docs/messenger-platform/send-messages/template/media)
            - [ ] Open Graph Template
            - [ ] Airline Boarding Pass Template
            - [ ] Airline Checkin Template
            - [ ] Airline Itinerary Template
            - [ ] Airline Flight Update Template
          - [x] [Buttons: Check documentation to format your buttons in your templates](https://developers.facebook.com/docs/messenger-platform/send-api-reference/buttons)
              - [x] [Call Button](https://developers.facebook.com/docs/messenger-platform/send-api-reference/call-button)
        - [ ] Miscellaneous
          - [x] [User profile](https://developers.facebook.com/docs/messenger-platform/user-profile)
          - [x] Messenger Profile API
            - [x] [Persistent Menu](https://developers.facebook.com/docs/messenger-platform/messenger-profile/persistent-menu)
            - [x] [Get Started Button](https://developers.facebook.com/docs/messenger-platform/messenger-profile/get-started-button)
            - [x] [Greeting Text](https://developers.facebook.com/docs/messenger-platform/messenger-profile/greeting-text)
            - [x] [Domain Whitelisting](https://developers.facebook.com/docs/messenger-platform/messenger-profile/domain-whitelisting)
            - [x] [Account Linking](https://developers.facebook.com/docs/messenger-platform/messenger-profile/account-linking-url)
            - [x] [Payment Settings](https://developers.facebook.com/docs/messenger-platform/messenger-profile/payment-settings)
            - [x] [Target Audience](https://developers.facebook.com/docs/messenger-platform/messenger-profile/target-audience)
            - [x] [Chat Extension Home URL (Covering but no tested)](https://developers.facebook.com/docs/messenger-platform/messenger-profile/home-url)
          - [ ] Plugin Reference
          - [ ] Messenger Code API
          - [ ] Messaging Insights API
        
Keywords: facebook bot mensseger platform wrapper django
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Natural Language :: English
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/markdown
