.. currentmodule:: cf
.. default-role:: obj

.. highlight:: bash

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

Dependencies
------------

See `<https://bitbucket.org/cfpython/cf-python/overview>`_ for the
current list of dependencies.


Install from PyPi  with pip
---------------------------

cf-python is available from the python package index (`<https://pypi.python.org/pypi/cf-python>`_).

::

   $ pip install cf-python

Install from source
-------------------

Download the cf package from `<https://bitbucket.org/cfpython/cf-python/downloads>`_

Unpack the library::

   $ tar zxvf cf-python-2.0.1.post1.tar.gz
   $ cd cf-python-2.0.1.post1

To install the cf package to a central location::

   $ python setup.py install

To install the cf package locally to the user in a default location::

   $ python setup.py install --user

To install the cf package in the <directory> of your choice::

   $ python setup.py install --home=<directory>


Issues
------

Please raise any questions or problems at
`<https://bitbucket.org/cfpython/cf-python/issues>`_