README update

This commit is contained in:
Taehoon Kim
2015-04-19 17:21:18 +09:00
parent fc7b7f3e43
commit 6dc17528ef
3 changed files with 56 additions and 30 deletions

View File

@@ -14,18 +14,52 @@ fbchat
.. image:: https://pypip.in/license/fbchat/badge.svg?style=flat
:target: https://pypi.python.org/pypi/fbchat
Facebook Chat (`Messenger <https://www.messenger.com/>`__) for Python. This project was inspired by `facebook-chat-api <https://github.com/Schmavery/facebook-chat-api>`__.
Facebook Chat (`Messenger <https://www.messenger.com/>`__) for Python. No XMPP or API key is needed. Just use your ID and PASSWORD.
This project was inspired by `facebook-chat-api <https://github.com/Schmavery/facebook-chat-api>`__.
Documentation
=============
Installation
============
Via pip:
To install fbchat, simply:
.. code-block:: console
$ pip install fbchat
Or, you can use:
.. code-block:: console
$ pip install fbchat
Or, you can also install manually:
.. code-block:: console
$ git clone git://github.com/carpedm20/fbchat.git
$ cd fbchat
$ python setup.py install
Echo bot example
================
.. code-block:: console
import fbchat
client = fbchat.Client("YOUR_ID", "YOUR_PASSWORD")
for op in client.listen():
client.sendMessage(op.message, op.sender)
Authors
=======

View File

@@ -1,38 +1,26 @@
# -*- coding: UTF-8 -*-
"""
Facebook Chat (Messenger) for Python
fbchat
~~~~~~
Facebook Chat (Messenger) for Python
:copyright: (c) 2015 by Taehoon Kim.
:license: BSD, see LICENSE for more details.
"""
from .client import *
__copyright__ = 'Copyright 2015 by Taehoon Kim'
__version__ = '0.0.2'
__license__ = 'BSD'
__author__ = 'Taehoon Kim'
__email__ = 'carpedm20@gmail.com'
__source__ = 'https://github.com/carpedm20/fbchat/'
__license__ = '''
New BSD License
Copyright (c) 2015, Taehoon Kim
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* The names of its contributors may not be used to endorse or promote products
derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
'''
__all__ = [
'Client',
]

View File

@@ -1,10 +1,14 @@
# -*- coding: UTF-8 -*-
"""
Core components for fbchat
"""
fbchat
~~~~~~
Facebook Chat (Messenger) for Python
:copyright: (c) 2015 by Taehoon Kim.
:license: BSD, see LICENSE for more details.
"""
import re
import json