1
0

METADATA 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. Metadata-Version: 2.2
  2. Name: xmpppy
  3. Version: 0.7.1
  4. Summary: XMPP implementation in Python
  5. Home-page: https://github.com/xmpppy/xmpppy
  6. Download-URL: https://pypi.org/project/xmpppy/
  7. Author: Alexey Nezhdanov
  8. Author-email: snakeru@users.sourceforge.net
  9. License: GPL
  10. Keywords: jabber,xmpp,RFC3920,RFC3921
  11. Platform: All
  12. Classifier: Programming Language :: Python
  13. Classifier: Programming Language :: Python :: 2
  14. Classifier: Programming Language :: Python :: 3
  15. Classifier: License :: OSI Approved :: GNU General Public License (GPL)
  16. Classifier: Development Status :: 4 - Beta
  17. Classifier: Operating System :: OS Independent
  18. Classifier: Natural Language :: English
  19. Classifier: Intended Audience :: Developers
  20. Classifier: Intended Audience :: Education
  21. Classifier: Intended Audience :: Information Technology
  22. Classifier: Intended Audience :: System Administrators
  23. Classifier: Intended Audience :: Telecommunications Industry
  24. Classifier: Topic :: Communications
  25. Classifier: Topic :: Communications :: Chat
  26. Classifier: Topic :: Database
  27. Classifier: Topic :: Internet
  28. Classifier: Topic :: Software Development :: Libraries
  29. Classifier: Topic :: System :: Networking
  30. Classifier: Topic :: Text Processing
  31. Classifier: Topic :: Utilities
  32. License-File: LICENSE
  33. Requires-Dist: six
  34. Dynamic: author
  35. Dynamic: author-email
  36. Dynamic: classifier
  37. Dynamic: description
  38. Dynamic: download-url
  39. Dynamic: home-page
  40. Dynamic: keywords
  41. Dynamic: license
  42. Dynamic: platform
  43. Dynamic: requires-dist
  44. Dynamic: summary
  45. ######
  46. xmpppy
  47. ######
  48. *Python 2/3 implementation of XMPP (RFC3920, RFC3921).*
  49. ----
  50. **Documentation**: http://xmpppy.sf.net/
  51. **Source Code**: https://github.com/xmpppy/xmpppy
  52. **Status**:
  53. .. image:: https://img.shields.io/pypi/pyversions/xmpppy.svg
  54. :target: https://pypi.org/project/xmpppy/
  55. .. image:: https://img.shields.io/pypi/v/xmpppy.svg
  56. :target: https://pypi.org/project/xmpppy/
  57. .. image:: https://img.shields.io/pypi/l/xmpppy.svg
  58. :target: https://pypi.org/project/xmpppy/
  59. .. image:: https://img.shields.io/pypi/dm/xmpppy.svg
  60. :target: https://pypi.org/project/xmpppy/
  61. ----
  62. *****
  63. About
  64. *****
  65. This library has been written to be compliant with
  66. `RFC3920 <https://datatracker.ietf.org/doc/rfc3920/>`_
  67. and
  68. `RFC3921 <https://datatracker.ietf.org/doc/rfc3921/>`_.
  69. ************
  70. Installation
  71. ************
  72. Using ``pip``, you can install the package with::
  73. pip install xmpppy --upgrade
  74. *****
  75. Usage
  76. *****
  77. As a library
  78. ============
  79. Regularly, the module is used as a library, like::
  80. jabberid = "foobar@xmpp.domain.tld"
  81. password = "secret"
  82. receiver = "bazqux@xmpp.domain.tld"
  83. message = "hello world"
  84. jid = xmpp.protocol.JID(jabberid)
  85. connection = xmpp.Client(server=jid.getDomain(), debug=debug)
  86. connection.connect()
  87. connection.auth(user=jid.getNode(), password=password, resource=jid.getResource())
  88. connection.send(xmpp.protocol.Message(to=receiver, body=message))
  89. Command line interface
  90. ======================
  91. The package also installs a command line program called ``xmpp-message``.
  92. Its synopsis is::
  93. xmpp-message --debug \
  94. --jabberid foobar@xmpp.domain.tld --password secret \
  95. --receiver bazqux@xmpp.domain.tld --message 'hello world'
  96. You can also put your credentials into an ``~/.xsend`` file, like::
  97. JID=foobar@xmpp.domain.tld
  98. PASSWORD=secret
  99. and then invoke ``xmpp-message`` omitting the ``--jabberid`` and ``--password`` options, like::
  100. xmpp-message --receiver bazqux@xmpp.domain.tld --message 'hello world'
  101. *************
  102. Documentation
  103. *************
  104. The canonical documentation is hosted at https://xmpppy.github.io/ and
  105. http://xmpppy.sourceforge.net/.
  106. For learning about how to use this module, please have a look at these spots
  107. within the code base.
  108. - The ``xmpp-message`` program, located at ``xmpp/cli.py``, for sending a single XMPP message.
  109. - The other programs within the ``doc/examples`` directory.
  110. - The docstrings within the library itself.
  111. *******
  112. Support
  113. *******
  114. If you have any questions about xmpppy usage or you have found a bug or want
  115. to share some ideas - you are welcome to join us on the
  116. `issue tracker <https://github.com/xmpppy/xmpppy/issues>`_
  117. or on the
  118. `xmpppy-devel mailing list <http://lists.sourceforge.net/lists/listinfo/xmpppy-devel>`_.
  119. **************
  120. Other projects
  121. **************
  122. - https://github.com/poezio/slixmpp
  123. - https://github.com/horazont/aioxmpp
  124. - https://github.com/Jajcus/pyxmpp2
  125. - https://github.com/fritzy/SleekXMPP
  126. - https://dev.gajim.org/gajim/python-nbxmpp
  127. - https://github.com/xmpppy/xmpppy/files/4346179/xmpp_libs.xlsx