.. quickstart

QuickStart
==========

Install ODPSlides
-----------------

The easiest way to install ODPSlides is::

    pip install odpslides
    
        OR on Linux
    sudo pip install odpslides
        OR perhaps
    pip install --user odpslides

In case of error, see :ref:`internal_pip_error`

.. _internal_source_install:

Installation From Source
------------------------

Much less common, but if installing from source, then
the best way to install odpslides is still ``pip``.

After navigating to the directory holding ODPSlides source code, do the following::

    cd full/path/to/odpslides
    pip install -e .
    
        OR on Linux
    sudo pip install -e .
        OR perhaps
    pip install --user -e .
    
This will execute the local ``setup.py`` file and insure that the pip-specific commands in ``setup.py`` are run.

Running ODPSlides
-----------------

ODPSlides is run from python scripts, typically from the command line.

If your editor supports script execution, most editors will execute the script when the function key **F5** is pressed.

See the Examples page for getting started.


.. _internal_pip_error:

pip Error Messages
------------------

If you get an error message that ``pip`` is not found, see `<https://pip.pypa.io/en/latest/installing.html>`_ for full description of ``pip`` installation.

There might be issues with ``pip`` failing on Linux with a message like::


    InsecurePlatformWarning
            or    
    Cannot fetch index base URL https://pypi.python.org/simple/

Certain Python platforms (specifically, versions of Python earlier than 2.7.9) have the InsecurePlatformWarning. If you encounter this warning, it is strongly recommended you upgrade to a newer Python version, or that you use pyOpenSSL.    

Also ``pip`` may be mis-configured and point to the wrong PyPI repository.
You need to fix this global problem with ``pip`` just to make python usable on your system.


If you give up on upgrading python or fixing ``pip``, 
you might also try downloading the odpslides source package 
(and all dependency source packages)
from PyPI and installing from source as shown above at :ref:`internal_source_install`