INSTALL

#######
Install
#######

`piecutter` is open-source software, published under BSD license.
See :doc:`/about/license` for details.

If you want to install a development environment, you should go to
:doc:`/contributing` documentation.


*************
Prerequisites
*************

* `Python`_ ==2.7.


************
As a library
************

In most cases, you will use `piecutter` as a dependency of another project.
In such a case, you should add ``piecutter`` in your main project's
requirements. Typically in :file:`setup.py`:

.. code:: python

   from setuptools import setup

   setup(
       install_requires=[
           'piecutter',
           #...
       ]
       # ...
   )

Then when you install your main project with your favorite package manager
(like `pip`_), `piecutter` will automatically installed.


**********
Standalone
**********

You can install `piecutter` with your favorite Python package manager.
As an example with `pip`_:

.. code:: sh

   pip install piecutter


*****
Check
*****

Check `piecutter` has been installed:

.. code:: sh

   python -c "import piecutter;print(piecutter.__version__)"

You should get `piecutter`'s version.


.. rubric:: References

.. target-notes::

.. _`Python`: http://python.org
.. _`pip`: https://pypi.python.org/pypi/pip/