Installation

You have three options for installing aioxmpp:

  1. Installing using your system’s package manager: only on ArchLinux and only if you use AUR, but if you do, this is the preferred way for your platform if you want to use aioxmpp in your project. It is not recommended if you want to hack on aioxmpp (use the third way then).
  2. Installing from PyPI: this is recommended if you simply want to use aioxmpp in a project or need it as an dependency for something. It is not recommended if you want to hack on aioxmpp.
  3. Installing in editable mode from source: this is recommended if you want to hack on aioxmpp or if you anticipate requiring bugfixes or new features while you use aioxmpp.

Note

You can help adding a third (and then new first way, because that way is the one I prefer most) way: Become a package maintainer for aioxmpp for your favourite Linux distribution. rku was so kind to create an ArchLinux package in AUR, but other distributions are still lacking the awesomeness (;-)) of aioxmpp. You can change that.

Installing using your system’s package manager

Currently, aioxmpp is only packaged in AUR of ArchLinux. On ArchLinux, that is the preferred way to install aioxmpp.

For other environments, you have to resort to the ways outlined below.

Installing from PyPI

Installing dependencies from PyPI

You will need some build dependencies for the dependencies, since some (such as lxml and PyOpenSSL) include C code which will be built during installation.

In addition, we recommend installing PyOpenSSL using your system’s package manager even if you install other dependencies using pip.

For Debian 8 (Jessie) and 9 (Stretch):

apt install --no-install-recommends build-essential libssl-dev \
  libxml2-dev libxslt1-dev python3-dev python3-openssl libz-dev \
  python3-pip

You can now proceed to installing aioxmpp via pip, which will install the dependencies from pip too.

Installing aioxmpp

Now, simply running

pip3 install aioxmpp

should install everything neccessary to run aioxmpp.

Note

On Debian Jessie (Debian 8), the pip from the packages is too old to install aioxmpp: it does not know the ~= version comparison operator. This is unfortunate, but ~= provides safety against accidental incompatible changes in dependencies.

To install on Debian Jessie, you will need to upgrade pip using:

pip3 install --upgrade setuptools
pip3 install --upgrade pip

(You may add the --user flag or use a virtualenv if you don’t want to upgrade pip system-wide.)

Installing in editable mode from source

Editable mode allows you to hack on aioxmpp while still being able to import it from everywhere. You can read more about it in the relevant chapter from the Python Packaging User Guide.

To install in editable mode, you first need a clone of the aioxmpp repository. Then you tell pip to install the local directory in editable mode. If you prefer to install dependencies using your system’s package manager, be sure to do so first (see _ug-installation-pypi-deps-packages), because pip3 will install them for you if they are missing.

git clone https://github.com/horazont/aioxmpp
cd aioxmpp
git checkout devel  # make sure to use the devel branch
pip3 install -e .  # install in editable mode

Running the unittests

To run the unittests, I personally recommend using the nosetests runner:

cd path/to/source/of/aioxmpp
nosetests3 tests

If any of the tests fail for you, this is worth a bug report.