5ee93b760a
- Update version numbers - Use badgen.net instead of shields.io - Remove badges from the docs (they're only present in the README)
62 lines
2.1 KiB
ReStructuredText
62 lines
2.1 KiB
ReStructuredText
``fbchat``: Facebook Chat (Messenger) for Python
|
|
================================================
|
|
|
|
.. image:: https://badgen.net/pypi/license/fbchat
|
|
:target: https://github.com/carpedm20/fbchat/tree/master/LICENSE
|
|
:alt: License: BSD 3-Clause
|
|
|
|
.. image:: https://badgen.net/badge/python/3.5,3.6,3.7,3.8,pypy?list=|
|
|
:target: https://pypi.python.org/pypi/fbchat
|
|
:alt: Supported python versions: 3.5, 3.6, 3.7, 3.8 and pypy
|
|
|
|
.. image:: https://badgen.net/pypi/v/fbchat
|
|
:target: https://pypi.python.org/pypi/fbchat
|
|
:alt: Project version
|
|
|
|
.. image:: https://readthedocs.org/projects/fbchat/badge/?version=stable
|
|
:target: https://fbchat.readthedocs.io
|
|
:alt: Documentation
|
|
|
|
.. image:: https://badgen.net/travis/carpedm20/fbchat
|
|
:target: https://travis-ci.org/carpedm20/fbchat
|
|
:alt: Travis CI
|
|
|
|
.. image:: https://badgen.net/badge/code%20style/black/black
|
|
:target: https://github.com/ambv/black
|
|
:alt: Code style
|
|
|
|
Facebook Chat (`Messenger <https://www.facebook.com/messages/>`__) for Python.
|
|
This project was inspired by `facebook-chat-api <https://github.com/Schmavery/facebook-chat-api>`__.
|
|
|
|
**No XMPP or API key is needed**. Just use your email and password.
|
|
|
|
Go to `Read the Docs <https://fbchat.readthedocs.io>`__ to see the full documentation,
|
|
or jump right into the code by viewing the `examples <https://github.com/carpedm20/fbchat/tree/master/examples>`__
|
|
|
|
Version warning:
|
|
----------------
|
|
``v2`` is currently being developed at the ``master`` branch and it's highly unstable. If you want to view the old ``v1``, go `here <https://github.com/carpedm20/fbchat/tree/v1>`__.
|
|
|
|
Additionally, you can view the project's progress `here <https://github.com/carpedm20/fbchat/projects/2>`__.
|
|
|
|
Installation:
|
|
-------------
|
|
|
|
.. code-block::
|
|
|
|
$ pip install fbchat
|
|
|
|
You can also install from source if you have ``pip>=19.0``:
|
|
|
|
.. code-block::
|
|
|
|
$ git clone https://github.com/carpedm20/fbchat.git
|
|
$ pip install fbchat
|
|
|
|
|
|
Maintainer
|
|
----------
|
|
|
|
- Mads Marquart / `@madsmtm <https://github.com/madsmtm>`__
|
|
- Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
|