From edfebe18a25c8f10b62e22cc1310a09a7d15f28a Mon Sep 17 00:00:00 2001
From: jonaswinkler <jonas.winkler@jpwinkler.de>
Date: Tue, 26 Jan 2021 20:48:32 +0100
Subject: [PATCH] removed all occurences of pipenv from the documentation
---
docs/administration.rst | 21 +++++----------------
docs/setup.rst | 25 ++++++++++++++-----------
docs/troubleshooting.rst | 2 +-
3 files changed, 20 insertions(+), 28 deletions(-)
diff --git a/docs/administration.rst b/docs/administration.rst
index 14b986e82..c54323e6e 100644
--- a/docs/administration.rst
+++ b/docs/administration.rst
@@ -121,27 +121,19 @@ After grabbing the new release and unpacking the contents, do the following:
dependencies. The dependencies required are listed in the section about
:ref:`bare metal installations <setup-bare_metal>`.
-2. Update python requirements. If you use Pipenv, this is done with the following steps.
+2. Update python requirements. Keep in mind to activate your virtual environment
+ before that, if you use one.
.. code:: shell-session
- $ pip install --upgrade pipenv
- $ cd /path/to/paperless
- $ pipenv clean
- $ pipenv install
-
- This creates a new virtual environment (or uses your existing environment)
- and installs all dependencies into it.
-
- You can also use the included ``requirements.txt`` file instead and create the virtual
- environment yourself. This file includes exactly the same dependencies.
+ $ pip install -r requirements.txt
3. Migrate the database.
.. code:: shell-session
$ cd src
- $ pipenv run python3 manage.py migrate
+ $ python3 manage.py migrate
This might not actually do anything. Not every new paperless version comes with new
database migrations.
@@ -195,7 +187,7 @@ or
.. code:: shell-session
$ cd /path/to/paperless/src
- $ pipenv run python manage.py <command> <arguments>
+ $ python3 manage.py <command> <arguments>
depending on whether you use docker or not.
@@ -462,6 +454,3 @@ Basic usage to disable encryption of your document store:
.. code::
decrypt_documents [--passphrase SECR3TP4SSPHRA$E]
-
-
-.. _Pipenv: https://pipenv.pypa.io/en/latest/
diff --git a/docs/setup.rst b/docs/setup.rst
index 574631a58..40f6bb1b6 100644
--- a/docs/setup.rst
+++ b/docs/setup.rst
@@ -20,7 +20,7 @@ Paperless consists of the following components:
.. code:: shell-session
$ cd /path/to/paperless/src/
- $ pipenv run gunicorn -c /usr/src/paperless/gunicorn.conf.py -b 0.0.0.0:8000 paperless.wsgi
+ $ gunicorn -c ../gunicorn.conf.py -b 0.0.0.0:8000 paperless.wsgi
or by any other means such as Apache ``mod_wsgi``.
@@ -35,7 +35,7 @@ Paperless consists of the following components:
.. code:: shell-session
$ cd /path/to/paperless/src/
- $ pipenv run python3 manage.py document_consumer
+ $ python3 manage.py document_consumer
.. _setup-task_processor:
@@ -67,7 +67,7 @@ Paperless consists of the following components:
.. code:: shell-session
$ cd /path/to/paperless/src/
- $ pipenv run python3 manage.py qcluster
+ $ python3 manage.py qcluster
* A `redis <https://redis.io/>`_ message broker: This is a really lightweight service that is responsible
for getting the tasks from the webserver and the consumer to the task scheduler. These run in a different
@@ -255,7 +255,7 @@ writing. Windows is not and will never be supported.
1. Install dependencies. Paperless requires the following packages.
* ``python3`` 3.6, 3.7, 3.8 (3.9 is untested).
- * ``python3-pip``, optionally ``pipenv`` for package installation
+ * ``python3-pip``
* ``python3-dev``
* ``fonts-liberation`` for generating thumbnails for plain text files
@@ -324,8 +324,13 @@ writing. Windows is not and will never be supported.
Adjust as necessary if you configured different folders.
-7. Install python requirements. Paperless comes with both Pipfiles for ``pipenv`` as well as with a ``requirements.txt``.
- Both will install exactly the same requirements. It is up to you if you wish to use a virtual environment or not.
+7. Install python requirements from the ``requirements.txt`` file.
+ It is up to you if you wish to use a virtual environment or not.
+
+ .. code:: shell-session
+
+ pip3 install -r requirements.txt
+
8. Go to ``/opt/paperless/src``, and execute the following commands:
@@ -654,14 +659,12 @@ management commands as below.
This will launch the container and initialize the PostgreSQL database.
- b) Without docker, open a shell in your virtual environment, switch to
+ b) Without docker, remember to activate any virtual environment, switch to
the ``src`` directory and create the database schema:
.. code:: shell-session
- $ cd /path/to/paperless
- $ pipenv shell
- $ cd src
+ $ cd /path/to/paperless/src
$ python3 manage.py migrate
This will not copy any data yet.
@@ -678,7 +681,7 @@ management commands as below.
$ python3 manage.py loaddata data.json
-6. Exit the shell.
+6. If operating inside Docker, you may exit the shell now.
.. code:: shell-session
diff --git a/docs/troubleshooting.rst b/docs/troubleshooting.rst
index ec430b477..f55d57af5 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -88,7 +88,7 @@ This happens when certain dependencies of paperless that are responsible for the
updated. After updating these, your current training data *might* not be compatible anymore. This can be ignored
in most cases. This warning will disappear automatically when paperless updates the training data.
- f you want to get rid of the warning or actually experience issues with automatic matching, delete
+If you want to get rid of the warning or actually experience issues with automatic matching, delete
the file ``classification_model.pickle`` in the data directory and let paperless recreate it.
Permission denied errors in the consumption directory