.. highlight:: shell

============
Installation
============


Stable release
--------------

To install XMLStarlet CFFI, run this command in your terminal:

.. code-block:: console

    $ pip install xmlstarlet

This is the preferred method to install XMLStarlet CFFI, as it will always install the most recent
stable release from https://pypi.org.

Binary wheels are automatically built and published for all major OS platforms
(Linux, MacOS, and Windows), as well as source packages on every tagged release.

Supported and tested on (64-bit) Python versions from 3.6+.


If you don't have `pip`_ installed, this `Python installation guide`_ can guide
you through the process.

.. _pip: https://pip.pypa.io
.. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/


From sources
------------

The sources for XMLStarlet CFFI can be downloaded from the `Github repo`_.

You can either clone the public repository:

.. code-block:: console

    $ git clone git://github.com/dimitern/xmlstarlet

Or download the `tarball`_:

.. code-block:: console

    $ curl -OL https://github.com/dimitern/xmlstarlet/tarball/master

Once you have a copy of the source, you can install it with:

.. code-block:: console

    $ python setup.py install

Ideally, you would do this inside a `virtualenv`.

.. _Github repo: https://github.com/dimitern/xmlstarlet
.. _tarball: https://github.com/dimitern/xmlstarlet/tarball/master