From 1d4b87ee46e86883b1b3d4d99c2dd60290d269ff Mon Sep 17 00:00:00 2001 From: Daniel Quinn Date: Fri, 12 Feb 2016 08:54:04 +0000 Subject: [PATCH] Update for #22 --- docs/requirements.rst | 56 ++++++++++++++++++++++++++++++++++++++----- 1 file changed, 50 insertions(+), 6 deletions(-) diff --git a/docs/requirements.rst b/docs/requirements.rst index b9dc4bbb5..5484f7db9 100644 --- a/docs/requirements.rst +++ b/docs/requirements.rst @@ -16,14 +16,58 @@ should work) that has the following software installed on it: .. _Tesseract: https://github.com/tesseract-ocr .. _Imagemagick: http://imagemagick.org/ -If you're not working on a virtual environment (like Vagrant or Docker), you -should probably be using a virtualenv, but that's your call. The reasons why -you might choose a virtualenv or not aren't really within the sope of this -document. +Notably, you should confirm how you access your Python3 installation. Many +Linux distributions will install Python3 in parallel to Python2, using the names +``python3`` and ``python`` respectively. The same goes for ``pip3`` and +``pip``. Using Python2 will likely break things, so make sure that you're using +the right version. + +For the purposes of simplicity, ``python`` and ``pip`` is used everywhere to +refer to their Python 3 versions. In addition to the above, there are a number of Python requirements, all of -which are listed in ``requirements.txt``. They will be installed automatically -with ``pip`` as part of the installation process. +which are listed in a file called ``requirements.txt`` in the project root. + +If you're not working on a virtual environment (like Vagrant or Docker), you +should probably be using a virtualenv, but that's your call. The reasons why +you might choose a virtualenv or not aren't really within the scope of this +document. Needless to say if you don't know what a virtualenv is, you should +probably figure that out before continuing. + + +.. _requirements-baremetal: + +Python-specific Requirements: No Virtualenv +------------------------------------------- + +If you don't care to use a virtual env, then installation of the Python +dependencies is easy: + +.. code:: bash + + $ pip install --user --requirement /path/to/paperless/requirements.txt + +This should download and install all of the requirements into +``${HOME}/.local``. Remember that your distribution may be using ``pip3`` as +mentioned above. + + +.. _requirements-virtualenv: + +Python-specific Requirements: Virtualenv +---------------------------------------- + +Using a virtualenv for this is pretty straightforward: create a virtualenv, +enter it, and install the requirements using the ``requirements.txt`` file: + +.. code:: bash + + $ virtualenv --python=/path/to/python3 /path/to/arbitrary/directory + $ . /path/to/arbitrary/directory/bin/activate + $ pip install --requirement /path/to/paperless/requirements.txt + +Now you're ready to go. Just remember to enter your virtualenv whenever you +want to use *Paperless*. .. _requirements-documentation: