Bump to v1.0.0!

Add multi-word match

README.rst

@@ -26,7 +26,8 @@ How it Works
 Paperless does not control your scanner, it only helps you deal with what your
 scanner produces
 
-1. Buy a document scanner like `this one`_ (used by me) or `this other one`_
+1. Buy a document scanner that can write to a place on your network.  If you
+   need some inspiration, have a look at the `scanner recommendations`_ page.
    recommended by another user.
 2. Set it up to "scan to FTP" or something similar. It should be able to push
    scanned images to a server without you having to do anything.  If your
@@ -118,8 +119,7 @@ The thing is, I'm doing ok for money, so I would instead ask you to donate to
 the `United Nations High Commissioner for Refugees`_.  They're doing important
 work and they need the money a lot more than I do.
 
-.. _this one: http://www.brother.ca/en-CA/Scanners/11/ProductDetail/ADS1500W?ProductDetail=productdetail
-.. _this other one: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
+.. _scanner recommendations: https://paperless.readthedocs.io/en/latest/scanners.html
 .. _ImageMagick: http://imagemagick.org/
 .. _Tesseract: https://github.com/tesseract-ocr
 .. _Unpaper: https://www.flameeyes.eu/projects/unpaper

docker-compose.yml.example

@@ -17,7 +17,7 @@ services:
         # value with nothing.
         environment:
             - PAPERLESS_OCR_LANGUAGES=
-        command: ["runserver", "0.0.0.0:8000"]
+        command: ["runserver", "--insecure", "0.0.0.0:8000"]
 
     consumer:
         image: pitkley/paperless
@@ -26,7 +26,7 @@ services:
             - 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 ':'.
-            - /path/to/arbitrary/place:/consume
+            - ./consume:/consume
             # Likewise, you can add a local path to mount a directory for
             # exporting. This is not strictly needed for paperless to
             # function, only if you're exporting your files: uncomment

docs/changelog.rst

@@ -1,6 +1,28 @@
 Changelog
 #########
 
+* 1.0.0
+  * Upgrade to Django 1.11.  **You'll need to run
+    ``pip install -r requirements.txt`` to after the usual ``git pull`` to
+    properly update**.
+  * Replace the templatetag-based hack we had for document listing in favour of
+    a slightly less ugly solution in the form of another template tag with less
+    copypasta.
+  * Support for multi-word-matches for auto-tagging thanks to an excellent
+    patch from `ishirav`_ `#277`_.
+  * Fixed a CSS bug reported by `Stefan Hagen`_ that caused an overlapping of
+    the text and checkboxes under some resolutions `#272`_.
+  * Patched the Docker config to force the serving of static files.  Credit for
+    this one goes to `dev-rke`_ via `#248`_.
+  * Fix file permissions during Docker start up thanks to `Pit`_ on `#268`_.
+  * Date fields in the admin are now expressed as HTML5 date fields thanks to
+    `Lukas Winkler`_'s issue `#278`_
+
+* 0.8.0
+  * Paperless can now run in a subdirectory on a host (``/paperless``), rather
+    than always running in the root (``/``) thanks to `maphy-psd`_'s work on
+    `#255`_.
+
 * 0.7.0
   * **Potentially breaking change**: As per `#235`_, Paperless will no longer
     automatically delete documents attached to correspondents when those
@@ -231,6 +253,11 @@ Changelog
 .. _Joshua Gilman: https://github.com/jmgilman
 .. _ayounggun: https://github.com/ayounggun
 .. _Kusti Skytén: https://github.com/kskyten
+.. _maphy-psd: https://github.com/maphy-psd
+.. _ishirav: https://github.com/ishirav
+.. _Stefan Hagen: https://github.com/xkpd3
+.. _dev-rke: https://github.com/dev-rke
+.. _Lukas Winkler: https://github.com/Findus23
 
 .. _#20: https://github.com/danielquinn/paperless/issues/20
 .. _#44: https://github.com/danielquinn/paperless/issues/44
@@ -271,3 +298,9 @@ Changelog
 .. _#232: https://github.com/danielquinn/paperless/issues/232
 .. _#235: https://github.com/danielquinn/paperless/issues/235
 .. _#236: https://github.com/danielquinn/paperless/issues/236
+.. _#255: https://github.com/danielquinn/paperless/pull/255
+.. _#268: https://github.com/danielquinn/paperless/pull/268
+.. _#277: https://github.com/danielquinn/paperless/pull/277
+.. _#272: https://github.com/danielquinn/paperless/issues/272
+.. _#248: https://github.com/danielquinn/paperless/issues/248
+.. _#278: https://github.com/danielquinn/paperless/issues/248

docs/guesswork.rst

@@ -80,6 +80,12 @@ text and matching algorithm.  From the help info there:
     uses a regex to match the PDF.  If you don't know what a regex is, you
     probably don't want this option.
 
+When using the "any" or "all" matching algorithms, you can search for terms that
+consist of multiple words by enclosing them in double quotes. For example, defining
+a match text of ``"Bank of America" BofA`` using the "any" algorithm, will match
+documents that contain either "Bank of America" or "BofA", but will not match
+documents containing "Bank of South America".
+
 Then just save your tag/correspondent and run another document through the
 consumer.  Once complete, you should see the newly-created document,
 automatically tagged with the appropriate data.

docs/index.rst

@@ -3,10 +3,10 @@
 Paperless
 =========
 
-Paperless is a simple Django application running in two parts: 
-a :ref:`consumer <utilities-consumer>` (the thing that does the indexing) and 
+Paperless is a simple Django application running in two parts:
+a :ref:`consumer <utilities-consumer>` (the thing that does the indexing) and
 the :ref:`webserver <utilities-webserver>` (the part that lets you search & download
-already-indexed documents). If you want to learn more about its functions keep on 
+already-indexed documents). If you want to learn more about its functions keep on
 reading after the installation section.
 
 
@@ -19,8 +19,8 @@ Paper is a nightmare.  Environmental issues aside, there's no excuse for it in
 the 21st century.  It takes up space, collects dust, doesn't support any form of
 a search feature, indexing is tedious, it's heavy and prone to damage & loss.
 
-I wrote this to make "going paperless" easier.  I do not have to worry about 
-finding stuff again. I feed documents right from the post box into the scanner and 
+I wrote this to make "going paperless" easier.  I do not have to worry about
+finding stuff again. I feed documents right from the post box into the scanner and
 then shred them.  Perhaps you might find it useful too.
 
 
@@ -40,4 +40,5 @@ Contents
    guesswork
    migrating
    troubleshooting
+   scanners
    changelog

docs/scanners.rst

@@ -0,0 +1,29 @@
+.. _scanners:
+
+Scanner Recommendations
+=======================
+
+As Paperless operates by watching a folder for new files, doesn't care what
+scanner you use, but sometimes finding a scanner that will write to an FTP,
+NFS, or SMB server can be difficult.  This page is here to help you find one
+that works right for you based on recommentations from other Paperless users.
+
++---------+----------------+-----+-----+-----+----------------+
+| Brand   | Model          | Supports        | Recommended By |
++---------+----------------+-----+-----+-----+----------------+
+|         |                | FTP | NFS | SMB |                |
++=========+================+=====+=====+=====+================+
+| Brother | `ADS-1500W`_   | yes | no  | yes | `danielquinn`_ |
++---------+----------------+-----+-----+-----+----------------+
+| Brother | `MFC-J6930DW`_ | yes |     |     | `ayounggun`_   |
++---------+----------------+-----+-----+-----+----------------+
+| Fujitsu | `ix500`_       | yes |     | yes | `eonist`_      |
++---------+----------------+-----+-----+-----+----------------+
+
+.. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
+.. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
+.. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
+
+.. _danielquinn: https://github.com/danielquinn
+.. _ayounggun: https://github.com/ayounggun
+.. _eonist: https://github.com/eonist

requirements.txt

@@ -1,4 +1,4 @@
-Django>=1.10,<1.11
+Django>=1.11,<2.0
 Pillow>=3.1.1
 django-crispy-forms>=1.6.1
 django-extensions>=1.7.6
@@ -21,6 +21,6 @@ pytest
 pytest-django
 pytest-sugar
 pytest-env
-pep8
+pycodestyle
 flake8
 tox

scripts/docker-entrypoint.sh

@@ -25,16 +25,16 @@ set_permissions() {
           echo "failed."
           echo ""
           echo "Either try to set it on your host-mounted directory"
-          echo "directly, or make sure that the directory has \`o+x\`"
+          echo "directly, or make sure that the directory has \`g+wx\`"
           echo "permissions and the files in it at least \`o+r\`."
       } >&2
-      chmod g+x "${!dir}" || {
+      chmod g+wx "${!dir}" || {
           echo "Changing group permissions of ${cur_dir_name} directory:"
           echo "  ${!dir}"
           echo "failed."
           echo ""
           echo "Either try to set it on your host-mounted directory"
-          echo "directly, or make sure that the directory has \`o+x\`"
+          echo "directly, or make sure that the directory has \`g+wx\`"
           echo "permissions and the files in it at least \`o+r\`."
       } >&2
     done

src/documents/models.py

@@ -1,3 +1,5 @@
+# coding=utf-8
+
 import dateutil.parser
 import logging
 import os
@@ -89,7 +91,7 @@ class MatchingModel(models.Model):
             search_kwargs = {"flags": re.IGNORECASE}
 
         if self.matching_algorithm == self.MATCH_ALL:
-            for word in self.match.split(" "):
+            for word in self._split_match():
                 search_result = re.search(
                     r"\b{}\b".format(word), text, **search_kwargs)
                 if not search_result:
@@ -97,7 +99,7 @@ class MatchingModel(models.Model):
             return True
 
         if self.matching_algorithm == self.MATCH_ANY:
-            for word in self.match.split(" "):
+            for word in self._split_match():
                 if re.search(r"\b{}\b".format(word), text, **search_kwargs):
                     return True
             return False
@@ -121,6 +123,21 @@ class MatchingModel(models.Model):
 
         raise NotImplementedError("Unsupported matching algorithm")
 
+    def _split_match(self):
+        """
+        Splits the match to individual keywords, getting rid of unnecessary
+        spaces and grouping quoted words together.
+
+        Example:
+          '  some random  words "with   quotes  " and   spaces'
+            ==>
+          ["some", "random", "words", "with\s+quotes", "and", "spaces"]
+        """
+        findterms = re.compile(r'"([^"]+)"|(\S+)').findall
+        normspace = re.compile(r"\s+").sub
+        return [normspace(r"\s+", (t[0] or t[1]).strip())
+                for t in findterms(self.match)]
+
     def save(self, *args, **kwargs):
 
         self.match = self.match.lower()

src/documents/templates/admin/change_list_results.html

@@ -1,6 +0,0 @@
-{% load hacks %}
-
-{# See documents.templatetags.hacks.change_list_results for an explanation #}
-
-{% change_list_results %}
-

src/documents/templates/admin/documents/document/change_form.html

@@ -0,0 +1,13 @@
+{% extends 'admin/change_form.html' %}
+
+
+{% block footer %}
+
+	{{ block.super }}
+
+	{# Hack to force Django to make the created date a date input rather than `text` (the default) #}
+	<script>
+		django.jQuery(".field-created input").first().attr("type", "date")
+	</script>
+
+{% endblock footer %}

src/documents/templates/admin/documents/document/change_list.html

@@ -0,0 +1,12 @@
+{% extends 'admin/change_list.html' %}
+
+
+{% load admin_actions from admin_list%}
+{% load result_list from hacks %}
+
+
+{% block result_list %}
+	{% if action_form and actions_on_top and cl.show_admin_actions %}{% admin_actions %}{% endif %}
+	{% result_list cl %}
+	{% if action_form and actions_on_bottom and cl.show_admin_actions %}{% admin_actions %}{% endif %}
+{% endblock %}

src/documents/templates/admin/documents/document/change_list_results.html

@@ -29,18 +29,13 @@
   .result .header {
     padding: 5px;
     background-color: #79AEC8;
-    height: 6em;
-  }
-  .result .header .checkbox {
-    margin-right: 5px;
   }
   .result .header .checkbox{
     width: 5%;
     float: left;
   }
   .result .header .info {
-    width: 90%;
-    float: left;
+    margin-left: 10%;
   }
   .result .header a,
   .result a.tag {

src/documents/templates/documents/index.html

@@ -6,5 +6,6 @@
     <meta charset="utf-8">
   </head>
   <body>
+		{# One day someone (maybe even myself) is going to write a proper web front-end for Paperless, and this is where it'll start. #}
   </body>
 </html>

src/documents/templatetags/hacks.py

@@ -1,41 +1,28 @@
-import os
-
-from django.contrib import admin
+from django.contrib.admin.templatetags.admin_list import (
+    result_headers,
+    result_hidden_fields,
+    results
+)
 from django.template import Library
-from django.template.loader import get_template
-
-from ..models import Document
 
 
 register = Library()
 
 
-@register.simple_tag(takes_context=True)
-def change_list_results(context):
+@register.inclusion_tag("admin/documents/document/change_list_results.html")
+def result_list(cl):
     """
-    Django has a lot of places where you can override defaults, but
-    unfortunately, `change_list_results.html` is not one of them.  In fact,
-    it's a downright pain in the ass to override this file on a per-model basis
-    and this is the cleanest way I could come up with.
-
-    Basically all we've done here is defined `change_list_results.html` in an
-    `admin` directory which globally overrides that file for *every* model.
-    That template however simply loads this templatetag which determines
-    whether we're currently looking at a `Document` listing or something else
-    and loads the appropriate file in each case.
-
-    Better work arounds for this are welcome as I hate this myself, but at the
-    moment, it's all I could come up with.
+    Copy/pasted from django.contrib.admin.templatetags.admin_list just so I can
+    modify the value passed to `.inclusion_tag()` in the decorator here.  There
+    must be a cleaner way... right?
     """
-
-    path = os.path.join(
-        os.path.dirname(admin.__file__),
-        "templates",
-        "admin",
-        "change_list_results.html"
-    )
-
-    if context["cl"].model == Document:
-        path = "admin/documents/document/change_list_results.html"
-
-    return get_template(path).render(context)
+    headers = list(result_headers(cl))
+    num_sorted_fields = 0
+    for h in headers:
+        if h['sortable'] and h['sorted']:
+            num_sorted_fields += 1
+    return {'cl': cl,
+            'result_hidden_fields': list(result_hidden_fields(cl)),
+            'result_headers': headers,
+            'num_sorted_fields': num_sorted_fields,
+            'results': list(results(cl))}

src/documents/tests/test_matchables.py

@@ -1,6 +1,6 @@
 from random import randint
 
-from django.test import TestCase
+from django.test import TestCase, override_settings
 
 from ..models import Correspondent, Document, Tag
 from ..signals import document_consumption_finished
@@ -16,9 +16,15 @@ class TestMatching(TestCase):
                 matching_algorithm=getattr(klass, algorithm)
             )
             for string in true:
-                self.assertTrue(instance.matches(string))
+                self.assertTrue(
+                    instance.matches(string),
+                    '"%s" should match "%s" but it does not' % (text, string)
+                )
             for string in false:
-                self.assertFalse(instance.matches(string))
+                self.assertFalse(
+                    instance.matches(string),
+                    '"%s" should not match "%s" but it does' % (text, string)
+                )
 
     def test_match_all(self):
 
@@ -54,6 +60,21 @@ class TestMatching(TestCase):
             )
         )
 
+        self._test_matching(
+            'brown fox "lazy dogs"',
+            "MATCH_ALL",
+            (
+                "the quick brown fox jumped over the lazy dogs",
+                "the quick brown fox jumped over the lazy  dogs",
+            ),
+            (
+                "the quick fox jumped over the lazy dogs",
+                "the quick brown wolf jumped over the lazy dogs",
+                "the quick brown fox jumped over the fat dogs",
+                "the quick brown fox jumped over the lazy... dogs",
+            )
+        )
+
     def test_match_any(self):
 
         self._test_matching(
@@ -89,6 +110,18 @@ class TestMatching(TestCase):
             )
         )
 
+        self._test_matching(
+            '"brown fox" " lazy  dogs "',
+            "MATCH_ANY",
+            (
+                "the quick brown fox",
+                "jumped over the lazy  dogs.",
+            ),
+            (
+                "the lazy fox jumped over the brown dogs",
+            )
+        )
+
     def test_match_literal(self):
 
         self._test_matching(
@@ -166,7 +199,8 @@ class TestMatching(TestCase):
         )
 
 
-class TestApplications(TestCase):
+@override_settings(POST_CONSUME_SCRIPT=None)
+class TestDocumentConsumptionFinishedSignal(TestCase):
     """
     We make use of document_consumption_finished, so we should test that it's
     doing what we expect wrt to tag & correspondent matching.

src/paperless/urls.py

@@ -1,13 +1,17 @@
 from django.conf import settings
-from django.conf.urls import url, static, include
+from django.conf.urls import include, static, url
 from django.contrib import admin
 from django.views.decorators.csrf import csrf_exempt
-
+from django.views.generic import RedirectView
 from rest_framework.routers import DefaultRouter
 
 from documents.views import (
-    FetchView, PushView,
-    CorrespondentViewSet, TagViewSet, DocumentViewSet, LogViewSet
+    CorrespondentViewSet,
+    DocumentViewSet,
+    FetchView,
+    LogViewSet,
+    PushView,
+    TagViewSet
 )
 from reminders.views import ReminderViewSet
 
@@ -39,7 +43,9 @@ urlpatterns = [
 
     # The Django admin
     url(r"admin/", admin.site.urls),
-    url(r"", admin.site.urls),  # This is going away
+
+    # Catch all redirect back to /admin
+    url(r"", RedirectView.as_view(permanent=True, url="/admin/")),
 
 ] + static.static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 

src/paperless/version.py

@@ -1 +1 @@
-__version__ = (0, 6, 1)
+__version__ = (1, 0, 0)

src/paperless_tesseract/signals.py

@@ -5,7 +5,7 @@ from .parsers import RasterisedDocumentParser
 
 class ConsumerDeclaration(object):
 
-    MATCHING_FILES = re.compile("^.*\.(pdf|jpg|gif|png|tiff?|pnm|bmp)$")
+    MATCHING_FILES = re.compile("^.*\.(pdf|jpe?g|gif|png|tiff?|pnm|bmp)$")
 
     @classmethod
     def handle(cls, sender, **kwargs):

src/paperless_tesseract/tests/test_signals.py

@@ -12,9 +12,9 @@ class SignalsTestCase(TestCase):
             "A document with a . in it", "Doc with -- in it"
         )
         suffixes = (
-            "pdf", "jpg", "gif", "png", "tiff", "tif", "pnm", "bmp",
-            "PDF", "JPG", "GIF", "PNG", "TIFF", "TIF", "PNM", "BMP",
-            "pDf", "jPg", "gIf", "pNg", "tIff", "tIf", "pNm", "bMp",
+            "pdf", "jpg", "jpeg", "gif", "png", "tiff", "tif", "pnm", "bmp",
+            "PDF", "JPG", "JPEG", "GIF", "PNG", "TIFF", "TIF", "PNM", "BMP",
+            "pDf", "jPg", "jpEg", "gIf", "pNg", "tIff", "tIf", "pNm", "bMp",
         )
 
         for prefix in prefixes:

src/pytest.ini

@@ -1,5 +1,6 @@
 [pytest]
 DJANGO_SETTINGS_MODULE=paperless.settings
+addopts = --pythonwarnings=all
 env =
   PAPERLESS_CONSUME=/tmp
   PAPERLESS_PASSPHRASE=THISISNOTASECRET

src/tox.ini

@@ -5,15 +5,18 @@
 
 [tox]
 skipsdist = True
-envlist = py34, py35, py36, pep8
+envlist = py34, py35, py36, pycodestyle
 
 [testenv]
 commands = pytest
 deps = -r{toxinidir}/../requirements.txt
 
-[testenv:pep8]
-commands=pep8
-deps=pep8
+[testenv:pycodestyle]
+commands=pycodestyle
+deps=pycodestyle
 
-[pep8]
-exclude=.tox,migrations,paperless/settings.py
+[pycodestyle]
+exclude=
+  .tox,
+  migrations,
+  paperless/settings.py