diff options
| author | Lance Stout <lancestout@gmail.com> | 2011-08-24 21:54:36 -0700 |
|---|---|---|
| committer | Lance Stout <lancestout@gmail.com> | 2011-08-24 22:09:02 -0700 |
| commit | ede59ab40e896293adba1278c42463fd8a5ba0fa (patch) | |
| tree | 674d619648a97ea2bfea3d77199392d4ed750435 /README.rst | |
| parent | 2a8082407656bf78a487afcf20017b10ca6475cc (diff) | |
| download | slixmpp-ede59ab40e896293adba1278c42463fd8a5ba0fa.tar.gz slixmpp-ede59ab40e896293adba1278c42463fd8a5ba0fa.tar.bz2 slixmpp-ede59ab40e896293adba1278c42463fd8a5ba0fa.tar.xz slixmpp-ede59ab40e896293adba1278c42463fd8a5ba0fa.zip | |
Clean and get setup.py working once and for all.
Fixes:
README.rst now included
Double line spacing removed from long_description
Source package now includes tests, examples, etc using Manifest.in
README.rst typos fixed
Added README.rst section on installing dnspython for Python3
Version bumped to RC2
Version is now taken from sleekxmpp.version.__version__ without
having to pull in the entire library
Added 'test' command for setup.py
Simplified testall.py
Docs build cleanly from source package after installation
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 20 |
1 files changed, 15 insertions, 5 deletions
@@ -34,7 +34,8 @@ SleekXMPP's design goals and philosphy are: Get the Code ------------ -.. code-block:: sh + +Get the latest stable version from PyPI:: pip install sleekxmpp @@ -54,6 +55,15 @@ The latest source code for SleekXMPP may be found on `Github **Develop Releases** - `Latest Develop Version <http://github.com/fritzy/SleekXMPP/zipball/develop>`_ +Installing DNSPython +--------------------- +If you are using Python3 and wish to use dnspython, you will have to checkout and +install the ``python3`` branch:: + + git clone http://github.com/rthalley/dnspython + cd dnspython + git checkout python3 + python3 setup.py install Discussion ---------- @@ -68,7 +78,6 @@ help with SleekXMPP. Documentation and Testing ------------------------- - Documentation can be found both inline in the code, and as a Sphinx project in ``/docs``. To generate the Sphinx documentation, follow the commands below. The HTML output will be in ``docs/_build/html``:: @@ -84,7 +93,6 @@ To run the test suite for SleekXMPP:: The SleekXMPP Boilerplate ------------------------- - Projects using SleekXMPP tend to follow a basic pattern for setting up client/component connections and configuration. Here is the gist of the boilerplate needed for a SleekXMPP based project. See the documetation or examples directory for more detailed archetypes for @@ -136,8 +144,10 @@ SleekXMPP projects:: xmpp.register_plugin('xep_0199') # XMPP Ping # If you are working with an OpenFire server, you will need - # to useuterborg Larsson version: - # xmppissl_version = ssl.PROTOCOL_SSLv3 + # to use a different SSL version: + # + # import ssl + # xmpp.ssl_version = ssl.PROTOCOL_SSLv3 if xmpp.connect(): xmpp.process(block=True) |