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

Using pip (or ...)
------------------

:Category: Stable version
:Precondition: :pypi:`pip` (or :pypi:`setuptools`) is installed

Execute the following command to install :pypi:`data-migrator` with :pypi:`pip`::

    pip install data-migrator

To update an already installed :pypi:`data-migrator` version, use::

    pip install -U data-migrator

.. hint::

    See also `pip related information`_ for installing Python packages.

.. _`pip related information`:  https://pip.pypa.io/en/latest/installing.html


Using a Source Distribution
---------------------------

After unpacking the :pypi:`data-migrator` source distribution,
enter the newly created directory "data-migrator-<version>" and run::

    python setup.py install


Using the Github Repository
---------------------------

:Category: Bleading edge
:Precondition: :pypi:`pip` is installed

Run the following command
to install the newest version from the `Github repository`_::

    pip install -e git+https://github.com/schubergphilis/data-migrator

To install a tagged version from the `Github repository`_, use::

    pip install -e git+https://github.com/schubergphilis/data-migrator@<tag>

where <tag> is the placeholder for an `existing tag`_. You can drop the -e and not
install in `editable mode`_ if you expect **not** to edit the source. Running in editable
mode allows to work on the code while the library is installed and available. Be sure
to make that pull-request ;-)

.. _`Github repository`: https://github.com/schubergphilis/data-migrator
.. _`existing tag`:      https://github.com/schubergphilis/data-migrator/tags
.. _`editable mode`:     https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs
