INSTALL

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

`django-confit` is open-source, 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, 3.3, 3.4, 3.5

.. warning::

   Django>=1.8 no longer supports Python 3.3, and Django<1.8 does not support
   Python 3.5. As an example, `django-confit` can't work with Django 1.7 and
   Python 3.5.


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

In most cases, you will use `django-confit` as a dependency of another project
(typically a Django project or a Django application).
In such a case, you should add ``django-confit`` in your main project's
requirements. Typically in :file:`setup.py`:

.. code:: python

   from setuptools import setup

   setup(
       install_requires=[
           'django-confit',
           #...
       ]
       # ...
   )

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


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

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

.. code:: sh

   pip install django-confit


*****
Check
*****

Check `django-confit` has been installed:

.. code:: sh

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

You should get `django_confit`'s version.


.. rubric:: Notes & references

.. seealso::

   :doc:`/about/changelog`

.. target-notes::

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