Merge branch 'master' into dev

jonaswinkler · Jan 21, 2019 · 4bd018d · 4bd018d
2 parents 99bfcd4 + 0256dcb
commit 4bd018d
Show file tree

Hide file tree

Showing 61 changed files with 4,845 additions and 637 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -18,6 +18,9 @@ max_line_length = off
 indent_size = 4
 indent_style = space
 
+[*.yml]
+indent_style = space
+
 # Tests don't get a line width restriction.  It's still a good idea to follow
 # the 79 character rule, but in the interests of clarity, tests often need to
 # violate it.

diff --git a/.travis.yml b/.travis.yml
@@ -2,24 +2,27 @@ language: python
 
 before_install:
 - sudo apt-get update -qq
-- sudo apt-get install -qq libpoppler-cpp-dev unpaper tesseract-ocr tesseract-ocr-eng tesseract-ocr-cat tesseract-ocr-deu
+- sudo apt-get install -qq libpoppler-cpp-dev unpaper tesseract-ocr
 
 sudo: false
 
 matrix:
     include:
-        - python: 3.4
-        - python: 3.5
-        - python: 3.6
+        - python: "3.4"
+        - python: "3.5"
+        - python: "3.6"
+        - python: "3.7-dev"
 
 install:
-    - pip install --requirement requirements.txt
-    - pip install sphinx
+    - pip install --upgrade pip pipenv sphinx
+    - pipenv lock -r > requirements.txt
+    - pip install -r requirements.txt
+
 script:
     - cd src/
     - pytest --cov
     - pycodestyle
     - sphinx-build -b html ../docs ../docs/_build -W
 
 after_success:
-    - coveralls
+  - coveralls
diff --git a/Dockerfile b/Dockerfile
@@ -4,8 +4,8 @@ LABEL maintainer="The Paperless Project https://github.com/danielquinn/paperless
       contributors="Guy Addadi <[email protected]>, Pit Kleyersburg <[email protected]>, \
         Sven Fischer <[email protected]>"
 
-# Copy requirements file and init script
-COPY requirements.txt /usr/src/paperless/
+# Copy Pipfiles file and init script
+COPY Pipfile* /usr/src/paperless/
 COPY scripts/docker-entrypoint.sh /sbin/docker-entrypoint.sh
 
 # Set export and consumption directories
@@ -21,7 +21,8 @@ RUN apk update --no-cache && apk add python3 gnupg libmagic libpq bash shadow cu
     python3 -m ensurepip && \
     rm -r /usr/lib/python*/ensurepip && \
     cd /usr/src/paperless && \
-    pip3 install --no-cache-dir -r requirements.txt && \
+    pip3 install --upgrade pip pipenv && \
+    pipenv install --system --deploy && \
 # Remove build dependencies
     apk del .build-dependencies && \
 # Create the consumption directory

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README-de.md b/README-de.md
@@ -1,7 +1,6 @@
-*[English](README.md)*<br/>
-*[Greek](README-el.md)*
+[ [en](README.md) | de | [el](README-el.md) ]
 
-# Paperless
+![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png)
 
 [![Dokumentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/) [![Chat](https://badges.gitter.im/danielquinn/paperless.svg)](https://gitter.im/danielquinn/paperless) [![Travis](https://travis-ci.org/danielquinn/paperless.svg?branch=master)](https://travis-ci.org/danielquinn/paperless) [![Coverage Status](https://coveralls.io/repos/github/danielquinn/paperless/badge.svg?branch=master)](https://coveralls.io/github/danielquinn/paperless?branch=master) [![Danke](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/danielquinn/paperless/blob/master/THANKS.md)
 

diff --git a/README-el.md b/README-el.md
@@ -1,7 +1,6 @@
-*[English](README.md)*<br/>
-*[German](README-de.md)*
+[ [en](README.md) | [de](README-de.md) | el ]
 
-# Paperless
+![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png)
 
 [![Documentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/) [![Chat](https://badges.gitter.im/danielquinn/paperless.svg)](https://gitter.im/danielquinn/paperless) [![Travis](https://travis-ci.org/danielquinn/paperless.svg?branch=master)](https://travis-ci.org/danielquinn/paperless) [![Coverage Status](https://coveralls.io/repos/github/danielquinn/paperless/badge.svg?branch=master)](https://coveralls.io/github/danielquinn/paperless?branch=master) [![Thanks](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/danielquinn/paperless/blob/master/THANKS.md)
 

diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
-*[German](README-de.md)*<br/>
-*[Greek](README-el.md)*
+[ en | [de](README-de.md) | [el](README-el.md) ]
 
-# Paperless
+![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png)
 
 [![Documentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/) [![Chat](https://badges.gitter.im/danielquinn/paperless.svg)](https://gitter.im/danielquinn/paperless) [![Travis](https://travis-ci.org/danielquinn/paperless.svg?branch=master)](https://travis-ci.org/danielquinn/paperless) [![Coverage Status](https://coveralls.io/repos/github/danielquinn/paperless/badge.svg?branch=master)](https://coveralls.io/github/danielquinn/paperless?branch=master) [![Thanks](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/danielquinn/paperless/blob/master/THANKS.md)
 

diff --git a/docker-compose.yml.example b/docker-compose.yml.example
@@ -17,6 +17,9 @@ services:
         volumes:
             - data:/usr/src/paperless/data
             - media:/usr/src/paperless/media
+						# You have to adapt the local path you want the consumption
+            # directory to mount to by modifying the part before the ':'.
+						- ./consume:/consume
         env_file: docker-compose.env
         # The reason the line is here is so that the webserver that doesn't do
         # any text recognition and doesn't have to install unnecessary
@@ -36,8 +39,8 @@ services:
         volumes:
             - data:/usr/src/paperless/data
             - media:/usr/src/paperless/media
-            # You have to adapt the local path you want the consumption
-            # directory to mount to by modifying the part before the ':'.
+            # This should be set to the same value as the consume directory
+					  # in the webserver service above.
             - ./consume:/consume
             # Likewise, you can add a local path to mount a directory for
             # exporting. This is not strictly needed for paperless to

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,18 @@
 Changelog
 #########
 
+2.6.1
+=====
+
+* We now have a logo, complete with a favicon :-)
+* Removed some problematic tests.
+* Fix the docker-compose example config to include a shared consume volume so
+  that using the push API will work for users of the Docker install.  Thanks to
+  `Colin Frei`_ for fixing this in `#466`_.
+* `khrise`_ submitted a pull request to include the ``added`` property to the
+  REST API `#471`.
+
+
 2.6.0
 =====
 
@@ -594,7 +606,9 @@ bulk of the work on this big change.
 .. _euri10: https://github.com/euri10
 .. _Ulli: https://github.com/Ulli2k
 .. _tsia: https://github.com/tsia
-.. _Sblop:  https://github.com/Sblop
+.. _Sblop: https://github.com/Sblop
+.. _Colin Frei: https://github.com/colinfrei
+.. _khrise: https://github.com/khrise
 
 .. _#20: https://github.com/danielquinn/paperless/issues/20
 .. _#44: https://github.com/danielquinn/paperless/issues/44
@@ -694,6 +708,8 @@ bulk of the work on this big change.
 .. _#440: https://github.com/danielquinn/paperless/pull/440
 .. _#441: https://github.com/danielquinn/paperless/pull/441
 .. _#442: https://github.com/danielquinn/paperless/pull/442
+.. _#466: https://github.com/danielquinn/paperless/pull/466
+.. _#471: https://github.com/danielquinn/paperless/pull/471
 
 .. _pipenv: https://docs.pipenv.org/
 .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/

diff --git a/docs/migrating.rst b/docs/migrating.rst
@@ -102,7 +102,7 @@ is similar:
     $ cd /path/to/project
     $ git pull
     $ docker build -t paperless .
-    $ docker-compose run --rm comsumer migrate
+    $ docker-compose run --rm consumer migrate
     $ docker-compose up -d
 
 If ``git pull`` doesn't report any changes, there is no need to continue with

diff --git a/docs/requirements.rst b/docs/requirements.rst
@@ -12,13 +12,15 @@ should work) that has the following software installed:
 * `Imagemagick`_ version 6.7.5 or higher
 * `unpaper`_
 * `libpoppler-cpp-dev`_ PDF rendering library
+* `optipng`_
 
 .. _Python3: https://python.org/
 .. _GNU Privacy Guard: https://gnupg.org
 .. _Tesseract: https://github.com/tesseract-ocr
 .. _Imagemagick: http://imagemagick.org/
 .. _unpaper: https://www.flameeyes.eu/projects/unpaper
 .. _libpoppler-cpp-dev: https://poppler.freedesktop.org/
+.. _optipng: http://optipng.sourceforge.net/
 
 Notably, you should confirm how you access your Python3 installation.  Many
 Linux distributions will install Python3 in parallel to Python2, using the

diff --git a/docs/utilities.rst b/docs/utilities.rst
@@ -214,5 +214,5 @@ This too is done via the ``manage.py`` script:
 
 That's it.  It'll loop over all of the documents in your database and attempt
 to match all of your tags to them.  If one matches, it'll be applied.  And
-don't worry, you can run this as often as you like, it' won't double-tag
+don't worry, you can run this as often as you like, it won't double-tag
 a document.
diff --git a/paperless.conf.example b/paperless.conf.example
@@ -219,6 +219,11 @@ PAPERLESS_DEBUG="false"
 #PAPERLESS_FORGIVING_OCR="false"
 
 
+# By default Paperless does not OCR a document if the text can be retrieved from
+# the document directly. Set to true to always OCR documents.
+#PAPERLESS_OCR_ALWAYS="false"
+
+
 ###############################################################################
 ####                            Interface                                  ####
 ###############################################################################