paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into dev

Browse Source
This commit is contained in:
Jonas Winkler 2019-05-21 13:06:16 +02:00
commit 32f3876590
35 changed files with 587 additions and 297 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -66,6 +66,7 @@ media/overrides.js
# Sqlite database # Sqlite database
db.sqlite3 db.sqlite3
db.sqlite3-journal
# PyCharm # PyCharm
.idea .idea

29
.travis.yml
View File

@ -12,6 +12,21 @@ matrix:
- python: "3.5" - python: "3.5"
- python: "3.6" - python: "3.6"
- python: "3.7-dev" - python: "3.7-dev"
- env:
- BUILD_DOCKER=1
# Variable to add to publish the Docker image:
# * DOCKER_USERNAME
# * DOCKER_PASSWORD, to be encrypted, use `travis encrypt DOCKER_PASSWORD=<password>`
services:
- docker
before_install:
- true
install:
- true
script:
- docker build --tag=the-paperless-project/paperless .
after_success:
- true
install: install:
- pip install --upgrade pip pipenv sphinx - pip install --upgrade pip pipenv sphinx
@ -26,3 +41,17 @@ script:
after_success: after_success:
- coveralls - coveralls
deploy:
- provider: script
skip_cleanup: true
script: ci/deploy-docker
on:
tags: true
condition: '"${BUILD_DOCKER}" = 1'
- provider: script
skip_cleanup: true
script: ci/deploy-docker
on:
branch: master
condition: '"${BUILD_DOCKER}" = 1'

31
Dockerfile
View File

@ -1,6 +1,6 @@
FROM alpine:3.8 FROM alpine:3.8
LABEL maintainer="The Paperless Project https://github.com/danielquinn/paperless" \ LABEL maintainer="The Paperless Project https://github.com/the-paperless-project/paperless" \
contributors="Guy Addadi <addadi@gmail.com>, Pit Kleyersburg <pitkley@googlemail.com>, \ contributors="Guy Addadi <addadi@gmail.com>, Pit Kleyersburg <pitkley@googlemail.com>, \
Sven Fischer <git-dev@linux4tw.de>" Sven Fischer <git-dev@linux4tw.de>"
@ -12,11 +12,30 @@ COPY scripts/docker-entrypoint.sh /sbin/docker-entrypoint.sh
ENV PAPERLESS_EXPORT_DIR=/export \ ENV PAPERLESS_EXPORT_DIR=/export \
PAPERLESS_CONSUMPTION_DIR=/consume PAPERLESS_CONSUMPTION_DIR=/consume
RUN apk add --no-cache \
RUN apk update --no-cache && apk add python3 gnupg libmagic libpq bash shadow curl \ bash \
sudo poppler tesseract-ocr imagemagick ghostscript unpaper optipng && \ curl \
apk add --virtual .build-dependencies \ ghostscript \
python3-dev poppler-dev postgresql-dev gcc g++ musl-dev zlib-dev jpeg-dev && \ gnupg \
imagemagick \
libmagic \
libpq \
optipng \
poppler \
python3 \
shadow \
sudo \
tesseract-ocr \
unpaper && \
apk add --no-cache --virtual .build-dependencies \
g++ \
gcc \
jpeg-dev \
musl-dev \
poppler-dev \
postgresql-dev \
python3-dev \
zlib-dev && \
# Install python dependencies # Install python dependencies
python3 -m ensurepip && \ python3 -m ensurepip && \
rm -r /usr/lib/python*/ensurepip && \ rm -r /usr/lib/python*/ensurepip && \

2
Pipfile
View File

@ -34,6 +34,8 @@ pytest-django = "*"
pytest-sugar = "*" pytest-sugar = "*"
pytest-env = "*" pytest-env = "*"
pytest-xdist = "*" pytest-xdist = "*"
psycopg2 = "*"
djangoql = "*"
[dev-packages] [dev-packages]
ipython = "*" ipython = "*"

242
Pipfile.lock generated
View File

@ -1,7 +1,7 @@
{ {
"_meta": { "_meta": {
"hash": { "hash": {
"sha256": "c2ba0313687a4018c574bbf2edace72777e3db768458e2fe3a346c6825c64c2c" "sha256": "971e0c975821925652865e34eed1c668bc6f52bb8217b776f35e87a66c936e1b"
}, },
"pipfile-spec": 6, "pipfile-spec": 6,
"requires": {}, "requires": {},
@ -117,11 +117,11 @@
}, },
"django": { "django": {
"hashes": [ "hashes": [
"sha256:25df265e1fdb74f7e7305a1de620a84681bcc9c05e84a3ed97e4a1a63024f18d", "sha256:0292a7ad7d8ffc9cfc6a77f043d2e81f5bbc360c0c4a1686e130ef3432437d23",
"sha256:d6d94554abc82ca37e447c3d28958f5ac39bd7d4adaa285543ae97fb1129fd69" "sha256:e89f613e3c1f7ff245ffee3560472f9fa9c07060b11f65e1de3cb763f8dcd4b9"
], ],
"index": "pypi", "index": "pypi",
"version": "==2.0.9" "version": "==2.0.10"
}, },
"django-cors-headers": { "django-cors-headers": {
"hashes": [ "hashes": [
@ -149,19 +149,26 @@
}, },
"django-filter": { "django-filter": {
"hashes": [ "hashes": [
"sha256:6f4e4bc1a11151178520567b50320e5c32f8edb552139d93ea3e30613b886f56", "sha256:3dafb7d2810790498895c22a1f31b2375795910680ac9c1432821cbedb1e176d",
"sha256:86c3925020c27d072cdae7b828aaa5d165c2032a629abbe3c3a1be1edae61c58" "sha256:a3014de317bef0cd43075a0f08dfa1d319a7ccc5733c3901fb860da70b0dda68"
], ],
"index": "pypi", "index": "pypi",
"version": "==2.0.0" "version": "==2.1.0"
},
"djangoql": {
"hashes": [
"sha256:7c488ec4e3362e5389ba3c1169d1ff9a27c4222601f32c6dbf6130ce04330d76"
],
"index": "pypi",
"version": "==0.12.3"
}, },
"djangorestframework": { "djangorestframework": {
"hashes": [ "hashes": [
"sha256:607865b0bb1598b153793892101d881466bd5a991de12bd6229abb18b1c86136", "sha256:79c6efbb2514bc50cf25906d7c0a5cfead714c7af667ff4bd110312cd380ae66",
"sha256:63f76cbe1e7d12b94c357d7e54401103b2e52aef0f7c1650d6c820ad708776e5" "sha256:a4138613b67e3a223be6c97f53b13d759c5b90d2b433bad670b8ebf95402075f"
], ],
"index": "pypi", "index": "pypi",
"version": "==3.9.0" "version": "==3.9.1"
}, },
"docopt": { "docopt": {
"hashes": [ "hashes": [
@ -194,10 +201,10 @@
}, },
"faker": { "faker": {
"hashes": [ "hashes": [
"sha256:228419b0a788a7ac867ebfafdd438461559ab1a0975edb607300852d9acaa78d", "sha256:16342dca4d92bfc83bab6a7daf6650e0ab087605a66bc38f17523fdb01757910",
"sha256:52a3dcc6a565b15fe1c95090321756d5a8a7c1caf5ab3df2f573ed70936ff518" "sha256:d871ea315b2dcba9138b8344f2c131a76ac62d6227ca39f69b0c889fec97376c"
], ],
"version": "==1.0.1" "version": "==1.0.2"
}, },
"filelock": { "filelock": {
"hashes": [ "hashes": [
@ -310,10 +317,10 @@
}, },
"packaging": { "packaging": {
"hashes": [ "hashes": [
"sha256:0886227f54515e592aaa2e5a553332c73962917f2831f1b0f9b9f4380a4b9807", "sha256:0c98a5d0be38ed775798ece1b9727178c4469d9c3b4ada66e8e6b7849f8732af",
"sha256:f95a1e147590f204328170981833854229bb2912ac3d5f89e2a8ccd2834800c9" "sha256:9e1cbf8c12b1f1ce0bb5344b8d7ecf66a6f8a6e91bcb0c84593ed6d3ab5c4ab3"
], ],
"version": "==18.0" "version": "==19.0"
}, },
"pdftotext": { "pdftotext": {
"hashes": [ "hashes": [
@ -324,46 +331,89 @@
}, },
"pillow": { "pillow": {
"hashes": [ "hashes": [
"sha256:00203f406818c3f45d47bb8fe7e67d3feddb8dcbbd45a289a1de7dd789226360", "sha256:051de330a06c99d6f84bcf582960487835bcae3fc99365185dc2d4f65a390c0e",
"sha256:0616f800f348664e694dddb0b0c88d26761dd5e9f34e1ed7b7a7d2da14b40cb7", "sha256:0ae5289948c5e0a16574750021bd8be921c27d4e3527800dc9c2c1d2abc81bf7",
"sha256:1f7908aab90c92ad85af9d2fec5fc79456a89b3adcc26314d2cde0e238bd789e", "sha256:0b1efce03619cdbf8bcc61cfae81fcda59249a469f31c6735ea59badd4a6f58a",
"sha256:2ea3517cd5779843de8a759c2349a3cd8d3893e03ab47053b66d5ec6f8bc4f93", "sha256:163136e09bd1d6c6c6026b0a662976e86c58b932b964f255ff384ecc8c3cefa3",
"sha256:48a9f0538c91fc136b3a576bee0e7cd174773dc9920b310c21dcb5519722e82c", "sha256:18e912a6ccddf28defa196bd2021fe33600cbe5da1aa2f2e2c6df15f720b73d1",
"sha256:5280ebc42641a1283b7b1f2c20e5b936692198b9dd9995527c18b794850be1a8", "sha256:24ec3dea52339a610d34401d2d53d0fb3c7fd08e34b20c95d2ad3973193591f1",
"sha256:5e34e4b5764af65551647f5cc67cf5198c1d05621781d5173b342e5e55bf023b", "sha256:267f8e4c0a1d7e36e97c6a604f5b03ef58e2b81c1becb4fccecddcb37e063cc7",
"sha256:63b120421ab85cad909792583f83b6ca3584610c2fe70751e23f606a3c2e87f0", "sha256:3273a28734175feebbe4d0a4cde04d4ed20f620b9b506d26f44379d3c72304e1",
"sha256:696b5e0109fe368d0057f484e2e91717b49a03f1e310f857f133a4acec9f91dd", "sha256:4c678e23006798fc8b6f4cef2eaad267d53ff4c1779bd1af8725cc11b72a63f3",
"sha256:870ed021a42b1b02b5fe4a739ea735f671a84128c0a666c705db2cb9abd528eb", "sha256:4d4bc2e6bb6861103ea4655d6b6f67af8e5336e7216e20fff3e18ffa95d7a055",
"sha256:916da1c19e4012d06a372127d7140dae894806fad67ef44330e5600d77833581", "sha256:505738076350a337c1740a31646e1de09a164c62c07db3b996abdc0f9d2e50cf",
"sha256:9303a289fa0811e1c6abd9ddebfc770556d7c3311cb2b32eff72164ddc49bc64", "sha256:5233664eadfa342c639b9b9977190d64ad7aca4edc51a966394d7e08e7f38a9f",
"sha256:9577888ecc0ad7d06c3746afaba339c94d62b59da16f7a5d1cff9e491f23dace", "sha256:5d95cb9f6cced2628f3e4de7e795e98b2659dfcc7176ab4a01a8b48c2c2f488f",
"sha256:987e1c94a33c93d9b209315bfda9faa54b8edfce6438a1e93ae866ba20de5956", "sha256:7eda4c737637af74bac4b23aa82ea6fbb19002552be85f0b89bc27e3a762d239",
"sha256:99a3bbdbb844f4fb5d6dd59fac836a40749781c1fa63c563bc216c27aef63f60", "sha256:801ddaa69659b36abf4694fed5aa9f61d1ecf2daaa6c92541bbbbb775d97b9fe",
"sha256:99db8dc3097ceafbcff9cb2bff384b974795edeb11d167d391a02c7bfeeb6e16", "sha256:825aa6d222ce2c2b90d34a0ea31914e141a85edefc07e17342f1d2fdf121c07c",
"sha256:a5a96cf49eb580756a44ecf12949e52f211e20bffbf5a95760ac14b1e499cd37", "sha256:9c215442ff8249d41ff58700e91ef61d74f47dfd431a50253e1a1ca9436b0697",
"sha256:aa6ca3eb56704cdc0d876fc6047ffd5ee960caad52452fbee0f99908a141a0ae", "sha256:a3d90022f2202bbb14da991f26ca7a30b7e4c62bf0f8bf9825603b22d7e87494",
"sha256:aade5e66795c94e4a2b2624affeea8979648d1b0ae3fcee17e74e2c647fc4a8a", "sha256:a631fd36a9823638fe700d9225f9698fb59d049c942d322d4c09544dc2115356",
"sha256:b78905860336c1d292409e3df6ad39cc1f1c7f0964e66844bbc2ebfca434d073", "sha256:a6523a23a205be0fe664b6b8747a5c86d55da960d9586db039eec9f5c269c0e6",
"sha256:b92f521cdc4e4a3041cc343625b699f20b0b5f976793fb45681aac1efda565f8", "sha256:a756ecf9f4b9b3ed49a680a649af45a8767ad038de39e6c030919c2f443eb000",
"sha256:bfde84bbd6ae5f782206d454b67b7ee8f7f818c29b99fd02bf022fd33bab14cb", "sha256:b117287a5bdc81f1bac891187275ec7e829e961b8032c9e5ff38b70fd036c78f",
"sha256:c2b62d3df80e694c0e4a0ed47754c9480521e25642251b3ab1dff050a4e60409", "sha256:ba04f57d1715ca5ff74bb7f8a818bf929a204b3b3c2c2826d1e1cc3b1c13398c",
"sha256:c5e2be6c263b64f6f7656e23e18a4a9980cffc671442795682e8c4e4f815dd9f", "sha256:cd878195166723f30865e05d87cbaf9421614501a4bd48792c5ed28f90fd36ca",
"sha256:c99aa3c63104e0818ec566f8ff3942fb7c7a8f35f9912cb63fd8e12318b214b2", "sha256:cee815cc62d136e96cf76771b9d3eb58e0777ec18ea50de5cfcede8a7c429aa8",
"sha256:dae06620d3978da346375ebf88b9e2dd7d151335ba668c995aea9ed07af7add4", "sha256:d1722b7aa4b40cf93ac3c80d3edd48bf93b9208241d166a14ad8e7a20ee1d4f3",
"sha256:db5499d0710823fa4fb88206050d46544e8f0e0136a9a5f5570b026584c8fd74", "sha256:d7c1c06246b05529f9984435fc4fa5a545ea26606e7f450bdbe00c153f5aeaad",
"sha256:f36baafd82119c4a114b9518202f2a983819101dcc14b26e43fc12cbefdce00e", "sha256:e9c8066249c040efdda84793a2a669076f92a301ceabe69202446abb4c5c5ef9",
"sha256:f52b79c8796d81391ab295b04e520bda6feed54d54931708872e8f9ae9db0ea1", "sha256:f227d7e574d050ff3996049e086e1f18c7bd2d067ef24131e50a1d3fe5831fbc",
"sha256:ff8cff01582fa1a7e533cb97f628531c4014af4b5f38e33cdcfe5eec29b6d888" "sha256:fc9a12aad714af36cf3ad0275a96a733526571e52710319855628f476dcb144e"
], ],
"index": "pypi", "index": "pypi",
"version": "==5.3.0" "version": "==5.4.1"
}, },
"pluggy": { "pluggy": {
"hashes": [ "hashes": [
"sha256:447ba94990e8014ee25ec853339faf7b0fc8050cdc3289d4d71f7f410fb90095", "sha256:8ddc32f03971bfdf900a81961a48ccf2fb677cf7715108f85295c67405798616",
"sha256:bde19360a8ec4dfd8a20dcb811780a30998101f078fc7ded6162f0076f50508f" "sha256:980710797ff6a041e9a73a5787804f848996ecaa6f8a1b1e08224a5894f2074a"
], ],
"version": "==0.8.0" "version": "==0.8.1"
},
"ply": {
"hashes": [
"sha256:00c7c1aaa88358b9c765b6d3000c6eec0ba42abca5351b095321aef446081da3",
"sha256:096f9b8350b65ebd2fd1346b12452efe5b9607f7482813ffca50c22722a807ce"
],
"version": "==3.11"
},
"psycopg2": {
"hashes": [
"sha256:02445ebbb3a11a3fe8202c413d5e6faf38bb75b4e336203ee144ca2c46529f94",
"sha256:0e9873e60f98f0c52339abf8f0339d1e22bfe5aae0bcf7aabd40c055175035ec",
"sha256:1148a5eb29073280bf9057c7fc45468592c1bb75a28f6df1591adb93c8cb63d0",
"sha256:259a8324e109d4922b0fcd046e223e289830e2568d6f4132a3702439e5fd532b",
"sha256:28dffa9ed4595429e61bacac41d3f9671bb613d1442ff43bcbec63d4f73ed5e8",
"sha256:314a74302d4737a3865d40ea50e430ce1543c921ba10f39d562e807cfe2edf2a",
"sha256:36b60201b6d215d7658a71493fdf6bd5e60ad9a0cffed39906627ff9f4f3afd3",
"sha256:3f9d532bce54c4234161176ff3b8688ff337575ca441ea27597e112dfcd0ee0c",
"sha256:5d222983847b40af989ad96c07fc3f07e47925e463baa5de716be8f805b41d9b",
"sha256:6757a6d2fc58f7d8f5d471ad180a0bd7b4dd3c7d681f051504fbea7ae29c8d6f",
"sha256:6a0e0f1e74edb0ab57d89680e59e7bfefad2bfbdf7c80eb38304d897d43674bb",
"sha256:6ca703ccdf734e886a1cf53eb702261110f6a8b0ed74bcad15f1399f74d3f189",
"sha256:8513b953d8f443c446aa79a4cc8a898bd415fc5e29349054f03a7d696d495542",
"sha256:9262a5ce2038570cb81b4d6413720484cb1bc52c064b2f36228d735b1f98b794",
"sha256:97441f851d862a0c844d981cbee7ee62566c322ebb3d68f86d66aa99d483985b",
"sha256:a07feade155eb8e69b54dd6774cf6acf2d936660c61d8123b8b6b1f9247b67d6",
"sha256:a9b9c02c91b1e3ec1f1886b2d0a90a0ea07cc529cb7e6e472b556bc20ce658f3",
"sha256:ae88216f94728d691b945983140bf40d51a1ff6c7fe57def93949bf9339ed54a",
"sha256:b360ffd17659491f1a6ad7c928350e229c7b7bd83a2b922b6ee541245c7a776f",
"sha256:b4221957ceccf14b2abdabef42d806e791350be10e21b260d7c9ce49012cc19e",
"sha256:b90758e49d5e6b152a460d10b92f8a6ccf318fcc0ee814dcf53f3a6fc5328789",
"sha256:c669ea986190ed05fb289d0c100cc88064351f2b85177cbfd3564c4f4847d18c",
"sha256:d1b61999d15c79cf7f4f7cc9021477aef35277fc52452cf50fd13b713c84424d",
"sha256:de7bb043d1adaaf46e38d47e7a5f703bb3dab01376111e522b07d25e1a79c1e1",
"sha256:e393568e288d884b94d263f2669215197840d097c7e5b0acd1a51c1ea7d1aba8",
"sha256:ed7e0849337bd37d89f2c2b0216a0de863399ee5d363d31b1e5330a99044737b",
"sha256:f153f71c3164665d269a5d03c7fa76ba675c7a8de9dc09a4e2c2cdc9936a7b41",
"sha256:f1fb5a8427af099beb7f65093cbdb52e021b8e6dbdfaf020402a623f4181baf5",
"sha256:f36b333e9f86a2fba960c72b90c34be6ca71819e300f7b1fc3d2b0f0b2c546cd",
"sha256:f4526d078aedd5187d0508aa5f9a01eae6a48a470ed678406da94b4cd6524b7e"
],
"index": "pypi",
"version": "==2.7.7"
}, },
"py": { "py": {
"hashes": [ "hashes": [
@ -396,34 +446,34 @@
}, },
"pyparsing": { "pyparsing": {
"hashes": [ "hashes": [
"sha256:40856e74d4987de5d01761a22d1621ae1c7f8774585acae358aa5c5936c6c90b", "sha256:66c9268862641abcac4a96ba74506e594c884e3f57690a696d21ad8210ed667a",
"sha256:f353aab21fd474459d97b709e527b5571314ee5f067441dc9f88e33eecd96592" "sha256:f6c5ef0d7480ad048c054c37632c67fca55299990fff127850181659eea33fc3"
], ],
"version": "==2.3.0" "version": "==2.3.1"
}, },
"pytest": { "pytest": {
"hashes": [ "hashes": [
"sha256:f689bf2fc18c4585403348dd56f47d87780bf217c53ed9ae7a3e2d7faa45f8e9", "sha256:41568ea7ecb4a68d7f63837cf65b92ce8d0105e43196ff2b26622995bb3dc4b2",
"sha256:f812ea39a0153566be53d88f8de94839db1e8a05352ed8a49525d7d7f37861e9" "sha256:c3c573a29d7c9547fb90217ece8a8843aa0c1328a797e200290dc3d0b4b823be"
], ],
"index": "pypi", "index": "pypi",
"version": "==4.0.2" "version": "==4.1.1"
}, },
"pytest-cov": { "pytest-cov": {
"hashes": [ "hashes": [
"sha256:513c425e931a0344944f84ea47f3956be0e416d95acbd897a44970c8d926d5d7", "sha256:0ab664b25c6aa9716cbf203b17ddb301932383046082c081b9848a0edf5add33",
"sha256:e360f048b7dae3f2f2a9a4d067b2dd6b6a015d384d1577c994a43f3f7cbad762" "sha256:230ef817450ab0699c6cc3c9c8f7a829c34674456f2ed8df1fe1d39780f7c87f"
], ],
"index": "pypi", "index": "pypi",
"version": "==2.6.0" "version": "==2.6.1"
}, },
"pytest-django": { "pytest-django": {
"hashes": [ "hashes": [
"sha256:deffd9d65827c582bd0a85638a0fe52f0eb65a764872ddcee9ce51cdf6ae9f55", "sha256:1a5d33be930e3172fa238643a380414dc369fe8fa4b3c3de25e59ed142950736",
"sha256:fe1f71a0171f6b7edac37654da0904c9bd5ffba5221ab5a76779ab870611f41f" "sha256:e88e471d3d0f9acfb6293bb03d0ee8a33ed978734e92ea6b5312163a6c9e87cc"
], ],
"index": "pypi", "index": "pypi",
"version": "==3.4.4" "version": "==3.4.5"
}, },
"pytest-env": { "pytest-env": {
"hashes": [ "hashes": [
@ -434,10 +484,10 @@
}, },
"pytest-forked": { "pytest-forked": {
"hashes": [ "hashes": [
"sha256:e4500cd0509ec4a26535f7d4112a8cc0f17d3a41c29ffd4eab479d2a55b30805", "sha256:260d03fbd38d5ce41a657759e8d19bc7c8cfa6d0dcfa36c0bc9742d33bc30742",
"sha256:f275cb48a73fc61a6710726348e1da6d68a978f0ec0c54ece5a5fae5977e5a08" "sha256:8d05c2e6f33cd4422571b2b1bb309720c398b0549cff499e3e4cde661875ab54"
], ],
"version": "==0.2" "version": "==1.0.1"
}, },
"pytest-sugar": { "pytest-sugar": {
"hashes": [ "hashes": [
@ -449,11 +499,11 @@
}, },
"pytest-xdist": { "pytest-xdist": {
"hashes": [ "hashes": [
"sha256:96f893094c89fddeaff3f4783f4807f7aeb138be1a0d87a8805057b6af1201b5", "sha256:107e9db0ee30ead02ca93e7d6d4846675f1b2142234f0eb1cd4d76739cd9ae6f",
"sha256:aab1402f2b063df48bf044b042707610f8fcc4c49d0eb9c10e79e30b3f26074f" "sha256:5795f665e112520fa5beab736ad957e7f36ce7d44210f4004be9d99f86529d97"
], ],
"index": "pypi", "index": "pypi",
"version": "==1.25.0" "version": "==1.26.0"
}, },
"python-dateutil": { "python-dateutil": {
"hashes": [ "hashes": [
@ -473,11 +523,11 @@
}, },
"python-gnupg": { "python-gnupg": {
"hashes": [ "hashes": [
"sha256:2d158dfc6b54927752b945ebe57e6a0c45da27747fa3b9ae66eccc0d2147ac0d", "sha256:45daf020b370bda13a1429c859fcdff0b766c0576844211446f9266cae97fb0e",
"sha256:faa69bab58ed0936f0ccf96c99b92369b7a1819305d37dfe5c927d21a437a09d" "sha256:85c231850a0275c9722f06e34b45a22510b83a6a6e88f93b5ae32ba04c95056c"
], ],
"index": "pypi", "index": "pypi",
"version": "==0.4.3" "version": "==0.4.4"
}, },
"python-levenshtein": { "python-levenshtein": {
"hashes": [ "hashes": [
@ -487,25 +537,25 @@
}, },
"pytz": { "pytz": {
"hashes": [ "hashes": [
"sha256:31cb35c89bd7d333cd32c5f278fca91b523b0834369e757f4c5641ea252236ca", "sha256:32b0891edff07e28efe91284ed9c31e123d84bea3fd98e1f72be2508f43ef8d9",
"sha256:8e0f8568c118d3077b46be7d654cc8167fa916092e28320cde048e54bfc9f1e6" "sha256:d5f05e487007e29e03409f9398d074e158d920d36eb82eaf66fb1136b0c5374c"
], ],
"index": "pypi", "index": "pypi",
"version": "==2018.7" "version": "==2018.9"
}, },
"regex": { "regex": {
"hashes": [ "hashes": [
"sha256:15b4a185ae9782133f398f8ab7c29612a6e5f34ea9411e4cd36e91e78c347ebe", "sha256:0bcd8ab8c812278981df3161db3f94f0ec72f1fa07020173c96f20e74bd7c16a",
"sha256:3852b76f0b6d7bd98d328d548716c151b79017f2b81347360f26e5db10fb6503", "sha256:20b1601b887e1073805adda2f8a09bb4c86dc7629c46c0d7bf28444dcb32920d",
"sha256:79a6a60ed1ee3b12eb0e828c01d75e3b743af6616d69add6c2fde1d425a4ba3f", "sha256:3c4327dd686d2e05b1b3d60a256fbf1c93c53001614ed8acd65453e09d40e10f",
"sha256:a2938c290b3be2c7cadafa21de3051f2ed23bfaf88728a1fe5dc552cbfdb0326", "sha256:5e8c6cef2cd964888d5fdf16f3db3dbaaa18c5c5c648161c52c8df065cc26ac5",
"sha256:aff7414712c9e6d260609da9c9af3aacebfbc307a4abe3376c7736e2a6c8563f", "sha256:666b03b1c33ef8105f28ecf0fd26f4480931a91a6e30e29e304c1d9eddce2209",
"sha256:d03782f0b0fa34f8f1dbdc94e27cf193b83c6105307a8c10563938c6d85180d9", "sha256:8afb6ecd80154464b1ad31a93228b63832526f9b0291a82a55287ae15c01de79",
"sha256:db79ac3d81e655dc12d38a865dd6d1b569a28fab4c53749051cd599a6eb7614f", "sha256:9326e1c5b9de6e74150bdd424789aecec41c7ecaf9e78bf4c3acfe6868ce1365",
"sha256:e803b3646c3f9c47f1f3dc870173c5d79c0fd2fd8e40bf917b97c7b56701baff", "sha256:e06eac198d9c76bcbe52b987b74ead0d353cfaa9f3d8cd907ec984f4bb20ea1e",
"sha256:e9660ccca360b6bd79606aab3672562ebb14bce6af6c501107364668543f4bef" "sha256:eee007ee39a02cb631b74f89f992766b9d7e952a750166f3e5a5baf8c328c070"
], ],
"version": "==2018.11.22" "version": "==2019.1.24"
}, },
"requests": { "requests": {
"hashes": [ "hashes": [
@ -565,11 +615,11 @@
}, },
"tox": { "tox": {
"hashes": [ "hashes": [
"sha256:2a8d8a63660563e41e64e3b5b677e81ce1ffa5e2a93c2c565d3768c287445800", "sha256:04f8f1aa05de8e76d7a266ccd14e0d665d429977cd42123bc38efa9b59964e9e",
"sha256:edfca7809925f49bdc110d0a2d9966bbf35a0c25637216d9586e7a5c5de17bfb" "sha256:25ef928babe88c71e3ed3af0c464d1160b01fca2dd1870a5bb26c2dea61a17fc"
], ],
"index": "pypi", "index": "pypi",
"version": "==3.6.1" "version": "==3.7.0"
}, },
"tzlocal": { "tzlocal": {
"hashes": [ "hashes": [
@ -586,10 +636,10 @@
}, },
"virtualenv": { "virtualenv": {
"hashes": [ "hashes": [
"sha256:686176c23a538ecc56d27ed9d5217abd34644823d6391cbeb232f42bf722baad", "sha256:58c359370401e0af817fb0070911e599c5fdc836166306b04fd0f278151ed125",
"sha256:f899fafcd92e1150f40c8215328be38ff24b519cd95357fa6e78e006c7638208" "sha256:729f0bcab430e4ef137646805b5b1d8efbb43fe53d4a0f33328624a84a5121f7"
], ],
"version": "==16.1.0" "version": "==16.3.0"
} }
}, },
"develop": { "develop": {
@ -602,10 +652,10 @@
}, },
"decorator": { "decorator": {
"hashes": [ "hashes": [
"sha256:2c51dff8ef3c447388fe5e4453d24a2bf128d3a4c32af3fabef1f01c6851ab82", "sha256:33cd704aea07b4c28b3eb2c97d288a06918275dac0ecebdaf1bc8a48d98adb9e",
"sha256:c39efa13fbdeb4506c476c9b3babf6a718da943dab7811c206005a4a956c080c" "sha256:cabb249f4710888a2fc0e13e9a16c343d932033718ff62e1e9bc93a9d3a9122b"
], ],
"version": "==4.3.0" "version": "==4.3.2"
}, },
"ipython": { "ipython": {
"hashes": [ "hashes": [
@ -631,10 +681,10 @@
}, },
"parso": { "parso": {
"hashes": [ "hashes": [
"sha256:35704a43a3c113cce4de228ddb39aab374b8004f4f2407d070b6a2ca784ce8a2", "sha256:4b8f9ed80c3a4a3191aa3261505d868aa552dd25649cb13a7d73b6b7315edf2d",
"sha256:895c63e93b94ac1e1690f5fdd40b65f07c8171e3e53cbd7793b5b96c0e0a7f24" "sha256:5a120be2e8863993b597f1c0437efca799e90e0793c98ae5d4e34ebd00140e31"
], ],
"version": "==0.3.1" "version": "==0.3.2"
}, },
"pexpect": { "pexpect": {
"hashes": [ "hashes": [

6
README-de.md
View File

@ -1,8 +1,8 @@
[ [en](README.md) | de | [el](README-el.md) ] [ [en](README.md) | de | [el](README-el.md) ]
![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png) ![Paperless](https://raw.githubusercontent.com/the-paperless-project/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) [![Dokumentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/) [![Chat](https://badges.gitter.im/the-paperless-project/paperless.svg)](https://gitter.im/danielquinn/paperless) [![Travis](https://travis-ci.org/the-paperless-project/paperless.svg?branch=master)](https://travis-ci.org/the-paperless-project/paperless) [![Coverage Status](https://coveralls.io/repos/github/the-paperless-project/paperless/badge.svg?branch=master)](https://coveralls.io/github/the-paperless-project/paperless?branch=master) [![Danke](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/the-paperless-project/paperless/blob/master/THANKS.md)
Indexiere und archiviere alle deine eingescannten Papierdokumente Indexiere und archiviere alle deine eingescannten Papierdokumente
@ -28,7 +28,7 @@ Paperless steuert nicht deinen Scanner, es hilft nur damit umzugehen, was der Sc
Hier das, was du bekommt: Hier das, was du bekommt:
![Vorher und Nachher](https://raw.githubusercontent.com/danielquinn/paperless/master/docs/_static/screenshot.png) ![Vorher und Nachher](https://raw.githubusercontent.com/the-paperless-project/paperless/master/docs/_static/screenshot.png)
## Dokumentation ## Dokumentation

6
README-el.md
View File

@ -1,8 +1,8 @@
[ [en](README.md) | [de](README-de.md) | el ] [ [en](README.md) | [de](README-de.md) | el ]
![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png) ![Paperless](https://raw.githubusercontent.com/the-paperless-project/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) [![Documentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/) [![Chat](https://badges.gitter.im/the-paperless-project/paperless.svg)](https://gitter.im/danielquinn/paperless) [![Travis](https://travis-ci.org/the-paperless-project/paperless.svg?branch=master)](https://travis-ci.org/the-paperless-project/paperless) [![Coverage Status](https://coveralls.io/repos/github/the-paperless-project/paperless/badge.svg?branch=master)](https://coveralls.io/github/the-paperless-project/paperless?branch=master) [![Thanks](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/the-paperless-project/paperless/blob/master/THANKS.md)
Ευρετήριο και αρχείο για όλα σας τα σκαναρισμένα έγγραφα Ευρετήριο και αρχείο για όλα σας τα σκαναρισμένα έγγραφα
@ -27,7 +27,7 @@
Αυτό είναι που θα πάρετε: Αυτό είναι που θα πάρετε:
![Το πριν και το μετά](https://raw.githubusercontent.com/danielquinn/paperless/master/docs/_static/screenshot.png) ![Το πριν και το μετά](https://raw.githubusercontent.com/the-paperless-project/paperless/master/docs/_static/screenshot.png)
## Documentation ## Documentation

17
README.md
View File

@ -1,8 +1,13 @@
[ en | [de](README-de.md) | [el](README-el.md) ] [ en | [de](README-de.md) | [el](README-el.md) ]
![Paperless](https://raw.githubusercontent.com/danielquinn/paperless/master/src/paperless/static/paperless/img/logo-dark.png) ![Paperless](https://raw.githubusercontent.com/the-paperless-project/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) [![Documentation](https://readthedocs.org/projects/paperless/badge/?version=latest)](https://paperless.readthedocs.org/)
[![Chat](https://badges.gitter.im/the-paperless-project/paperless.svg)](https://gitter.im/danielquinn/paperless)
[![Travis](https://travis-ci.org/the-paperless-project/paperless.svg?branch=master)](https://travis-ci.org/the-paperless-project/paperless)
[![Coverage Status](https://coveralls.io/repos/github/the-paperless-project/paperless/badge.svg?branch=master)](https://coveralls.io/github/the-paperless-project/paperless?branch=master)
[![StackShare](https://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](https://stackshare.io/the-paperless-project/the-paperless-project)
[![Thanks](https://img.shields.io/badge/THANKS-md-ff69b4.svg)](https://github.com/the-paperless-project/paperless/blob/master/THANKS.md)
Index and archive all of your scanned paper documents Index and archive all of your scanned paper documents
@ -27,12 +32,12 @@ Paperless does not control your scanner, it only helps you deal with what your s
Here's what you get: Here's what you get:
![The before and after](https://raw.githubusercontent.com/danielquinn/paperless/master/docs/_static/screenshot.png) ![The before and after](https://raw.githubusercontent.com/the-paperless-project/paperless/master/docs/_static/screenshot.png)
## Documentation ## Documentation
It's all available on [ReadTheDocs](https://paperless.readthedocs.org/). It's all available on [ReadTheDocs](https://paperless.readthedocs.io/).
## Requirements ## Requirements
@ -63,11 +68,11 @@ Paperless has been around a while now, and people are starting to build stuff on
* [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation. Runs on Mac, Linux, and Windows. * [Paperless Desktop](https://github.com/thomasbrueggemann/paperless-desktop): A desktop UI for your Paperless installation. Runs on Mac, Linux, and Windows.
* [ansible-role-paperless](https://github.com/ovv/ansible-role-paperless): An easy way to get Paperless running via Ansible. * [ansible-role-paperless](https://github.com/ovv/ansible-role-paperless): An easy way to get Paperless running via Ansible.
* [paperless-cli](https://github.com/stgarf/paperless-cli): A golang command line binary to interact with a Paperless instance.
## Similar Projects ## Similar Projects
There's another project out there called [Mayan EDMS](https://mayan.readthedocs.org/en/latest/) that has a surprising amount of technical overlap with Paperless. Also based on Django and using a consumer model with Tesseract and Unpaper, Mayan EDMS is *much* more featureful and comes with a slick UI as well, but still in Python 2. It may be that Paperless consumes fewer resources, but to be honest, this is just a guess as I haven't tested this myself. One thing's for certain though, *Paperless* is a **way** better name. There's another project out there called [Mayan EDMS](https://www.mayan-edms.com/) that has a surprising amount of technical overlap with Paperless. Also based on Django and using a consumer model with Tesseract and Unpaper, Mayan EDMS is *much* more featureful and comes with a slick UI as well, but still in Python 2. It may be that Paperless consumes fewer resources, but to be honest, this is just a guess as I haven't tested this myself. One thing's for certain though, *Paperless* is a **way** better name.
## Important Note ## Important Note

15
ci/deploy-docker Executable file
View File

@ -0,0 +1,15 @@
#!/bin/bash
if [ "${DOCKER_USERNAME}" == "" -o "${DOCKER_PASSWORD}" == "" ]
then
exit 0
fi
docker login --username=${DOCKER_USERNAME} --password=${DOCKER_PASSWORD}
if [ "${TRAVIS_TAG}" != "" ]
then
docker tag the-paperless-project/paperless the-paperless-project/paperless:${TRAVIS_TAG}
docker push the-paperless-project/paperless:${TRAVIS_TAG}
else
docker push the-paperless-project/paperless
fi

6
docker-compose.yml.example
View File

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

BIN
docs/_static/Screenshot_first_logged.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 60 KiB

BIN
docs/_static/Screenshot_first_run_login.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 26 KiB

BIN
docs/_static/Screenshot_upload_and_scanned.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 113 KiB

230
docs/changelog.rst
View File

@ -1,6 +1,23 @@
Changelog Changelog
######### #########
2.7.0
=====
* `syntonym`_ submitted a pull request to catch IMAP connection errors `#475`_.
* `Stéphane Brunner`_ added ``psycopg2`` to the Pipfile `#489`_. He also fixed
a syntax error in ``docker-compose.yml.example`` `#488`_ and added [DjangoQL](https://github.com/ivelum/djangoql),
which allows a litany of handy search functionality `#492`_.
* `CkuT`_ and `JOKer`_ hacked out a simple, but super-helpful optimisation to
how the thumbnails are served up, improving performance considerably `#481`_.
* `tsia`_ added a few fields to the tags REST API. `#483`_.
* `Brian Cribbs`_ improved the documentation to help people using Paperless
over NFS `#484`_.
* `Brendan M. Sleight`_ updated the documentation to include a note for setting the
``DEBUG`` value. The ``paperless.conf.example`` file was also updated to
mirror the project defaults.
2.6.1 2.6.1
===== =====
@ -10,7 +27,7 @@ Changelog
that using the push API will work for users of the Docker install. Thanks to that using the push API will work for users of the Docker install. Thanks to
`Colin Frei`_ for fixing this in `#466`_. `Colin Frei`_ for fixing this in `#466`_.
* `khrise`_ submitted a pull request to include the ``added`` property to the * `khrise`_ submitted a pull request to include the ``added`` property to the
REST API `#471`. REST API `#471`_.
2.6.0 2.6.0
@ -609,107 +626,118 @@ bulk of the work on this big change.
.. _Sblop: https://github.com/Sblop .. _Sblop: https://github.com/Sblop
.. _Colin Frei: https://github.com/colinfrei .. _Colin Frei: https://github.com/colinfrei
.. _khrise: https://github.com/khrise .. _khrise: https://github.com/khrise
.. _syntonym: https://github.com/syntonym
.. _JOKer: https://github.com/MasterofJOKers
.. _Brian Cribbs: https://github.com/cribbstechnolog
.. _Brendan M. Sleight: https://github.com/bmsleight
.. _#20: https://github.com/danielquinn/paperless/issues/20 .. _#20: https://github.com/the-paperless-project/paperless/issues/20
.. _#44: https://github.com/danielquinn/paperless/issues/44 .. _#44: https://github.com/the-paperless-project/paperless/issues/44
.. _#45: https://github.com/danielquinn/paperless/issues/45 .. _#45: https://github.com/the-paperless-project/paperless/issues/45
.. _#47: https://github.com/danielquinn/paperless/issues/47 .. _#47: https://github.com/the-paperless-project/paperless/issues/47
.. _#48: https://github.com/danielquinn/paperless/issues/48 .. _#48: https://github.com/the-paperless-project/paperless/issues/48
.. _#53: https://github.com/danielquinn/paperless/issues/53 .. _#53: https://github.com/the-paperless-project/paperless/issues/53
.. _#54: https://github.com/danielquinn/paperless/issues/54 .. _#54: https://github.com/the-paperless-project/paperless/issues/54
.. _#57: https://github.com/danielquinn/paperless/issues/57 .. _#57: https://github.com/the-paperless-project/paperless/issues/57
.. _#60: https://github.com/danielquinn/paperless/issues/60 .. _#60: https://github.com/the-paperless-project/paperless/issues/60
.. _#67: https://github.com/danielquinn/paperless/issues/67 .. _#67: https://github.com/the-paperless-project/paperless/issues/67
.. _#68: https://github.com/danielquinn/paperless/issues/68 .. _#68: https://github.com/the-paperless-project/paperless/issues/68
.. _#71: https://github.com/danielquinn/paperless/issues/71 .. _#71: https://github.com/the-paperless-project/paperless/issues/71
.. _#81: https://github.com/danielquinn/paperless/issues/81 .. _#81: https://github.com/the-paperless-project/paperless/issues/81
.. _#89: https://github.com/danielquinn/paperless/issues/89 .. _#89: https://github.com/the-paperless-project/paperless/issues/89
.. _#94: https://github.com/danielquinn/paperless/issues/94 .. _#94: https://github.com/the-paperless-project/paperless/issues/94
.. _#98: https://github.com/danielquinn/paperless/issues/98 .. _#98: https://github.com/the-paperless-project/paperless/issues/98
.. _#112: https://github.com/danielquinn/paperless/issues/112 .. _#112: https://github.com/the-paperless-project/paperless/issues/112
.. _#121: https://github.com/danielquinn/paperless/issues/121 .. _#121: https://github.com/the-paperless-project/paperless/issues/121
.. _#131: https://github.com/danielquinn/paperless/issues/131 .. _#131: https://github.com/the-paperless-project/paperless/issues/131
.. _#146: https://github.com/danielquinn/paperless/issues/146 .. _#146: https://github.com/the-paperless-project/paperless/issues/146
.. _#148: https://github.com/danielquinn/paperless/pull/148 .. _#148: https://github.com/the-paperless-project/paperless/pull/148
.. _#150: https://github.com/danielquinn/paperless/pull/150 .. _#150: https://github.com/the-paperless-project/paperless/pull/150
.. _#158: https://github.com/danielquinn/paperless/issues/158 .. _#158: https://github.com/the-paperless-project/paperless/issues/158
.. _#171: https://github.com/danielquinn/paperless/issues/171 .. _#171: https://github.com/the-paperless-project/paperless/issues/171
.. _#172: https://github.com/danielquinn/paperless/issues/172 .. _#172: https://github.com/the-paperless-project/paperless/issues/172
.. _#179: https://github.com/danielquinn/paperless/pull/179 .. _#179: https://github.com/the-paperless-project/paperless/pull/179
.. _#199: https://github.com/danielquinn/paperless/issues/199 .. _#199: https://github.com/the-paperless-project/paperless/issues/199
.. _#200: https://github.com/danielquinn/paperless/issues/200 .. _#200: https://github.com/the-paperless-project/paperless/issues/200
.. _#206: https://github.com/danielquinn/paperless/issues/206 .. _#206: https://github.com/the-paperless-project/paperless/issues/206
.. _#212: https://github.com/danielquinn/paperless/pull/212 .. _#212: https://github.com/the-paperless-project/paperless/pull/212
.. _#220: https://github.com/danielquinn/paperless/pull/220 .. _#220: https://github.com/the-paperless-project/paperless/pull/220
.. _#224: https://github.com/danielquinn/paperless/pull/224 .. _#224: https://github.com/the-paperless-project/paperless/pull/224
.. _#226: https://github.com/danielquinn/paperless/pull/226 .. _#226: https://github.com/the-paperless-project/paperless/pull/226
.. _#227: https://github.com/danielquinn/paperless/pull/227 .. _#227: https://github.com/the-paperless-project/paperless/pull/227
.. _#228: https://github.com/danielquinn/paperless/pull/228 .. _#228: https://github.com/the-paperless-project/paperless/pull/228
.. _#229: https://github.com/danielquinn/paperless/pull/229 .. _#229: https://github.com/the-paperless-project/paperless/pull/229
.. _#230: https://github.com/danielquinn/paperless/pull/230 .. _#230: https://github.com/the-paperless-project/paperless/pull/230
.. _#232: https://github.com/danielquinn/paperless/issues/232 .. _#232: https://github.com/the-paperless-project/paperless/issues/232
.. _#235: https://github.com/danielquinn/paperless/issues/235 .. _#235: https://github.com/the-paperless-project/paperless/issues/235
.. _#236: https://github.com/danielquinn/paperless/issues/236 .. _#236: https://github.com/the-paperless-project/paperless/issues/236
.. _#255: https://github.com/danielquinn/paperless/pull/255 .. _#255: https://github.com/the-paperless-project/paperless/pull/255
.. _#268: https://github.com/danielquinn/paperless/pull/268 .. _#268: https://github.com/the-paperless-project/paperless/pull/268
.. _#277: https://github.com/danielquinn/paperless/pull/277 .. _#277: https://github.com/the-paperless-project/paperless/pull/277
.. _#272: https://github.com/danielquinn/paperless/issues/272 .. _#272: https://github.com/the-paperless-project/paperless/issues/272
.. _#248: https://github.com/danielquinn/paperless/issues/248 .. _#248: https://github.com/the-paperless-project/paperless/issues/248
.. _#278: https://github.com/danielquinn/paperless/issues/248 .. _#278: https://github.com/the-paperless-project/paperless/issues/248
.. _#283: https://github.com/danielquinn/paperless/issues/283 .. _#283: https://github.com/the-paperless-project/paperless/issues/283
.. _#256: https://github.com/danielquinn/paperless/pull/256 .. _#256: https://github.com/the-paperless-project/paperless/pull/256
.. _#285: https://github.com/danielquinn/paperless/pull/285 .. _#285: https://github.com/the-paperless-project/paperless/pull/285
.. _#291: https://github.com/danielquinn/paperless/pull/291 .. _#291: https://github.com/the-paperless-project/paperless/pull/291
.. _#295: https://github.com/danielquinn/paperless/pull/295 .. _#295: https://github.com/the-paperless-project/paperless/pull/295
.. _#299: https://github.com/danielquinn/paperless/issues/299 .. _#299: https://github.com/the-paperless-project/paperless/issues/299
.. _#300: https://github.com/danielquinn/paperless/pull/300 .. _#300: https://github.com/the-paperless-project/paperless/pull/300
.. _#301: https://github.com/danielquinn/paperless/issues/301 .. _#301: https://github.com/the-paperless-project/paperless/issues/301
.. _#303: https://github.com/danielquinn/paperless/issues/303 .. _#303: https://github.com/the-paperless-project/paperless/issues/303
.. _#305: https://github.com/danielquinn/paperless/issues/305 .. _#305: https://github.com/the-paperless-project/paperless/issues/305
.. _#306: https://github.com/danielquinn/paperless/issues/306 .. _#306: https://github.com/the-paperless-project/paperless/issues/306
.. _#308: https://github.com/danielquinn/paperless/issues/308 .. _#308: https://github.com/the-paperless-project/paperless/issues/308
.. _#311: https://github.com/danielquinn/paperless/pull/311 .. _#311: https://github.com/the-paperless-project/paperless/pull/311
.. _#312: https://github.com/danielquinn/paperless/pull/312 .. _#312: https://github.com/the-paperless-project/paperless/pull/312
.. _#313: https://github.com/danielquinn/paperless/pull/313 .. _#313: https://github.com/the-paperless-project/paperless/pull/313
.. _#322: https://github.com/danielquinn/paperless/pull/322 .. _#322: https://github.com/the-paperless-project/paperless/pull/322
.. _#328: https://github.com/danielquinn/paperless/pull/328 .. _#328: https://github.com/the-paperless-project/paperless/pull/328
.. _#253: https://github.com/danielquinn/paperless/issues/253 .. _#253: https://github.com/the-paperless-project/paperless/issues/253
.. _#262: https://github.com/danielquinn/paperless/issues/262 .. _#262: https://github.com/the-paperless-project/paperless/issues/262
.. _#323: https://github.com/danielquinn/paperless/issues/323 .. _#323: https://github.com/the-paperless-project/paperless/issues/323
.. _#344: https://github.com/danielquinn/paperless/pull/344 .. _#344: https://github.com/the-paperless-project/paperless/pull/344
.. _#351: https://github.com/danielquinn/paperless/pull/351 .. _#351: https://github.com/the-paperless-project/paperless/pull/351
.. _#352: https://github.com/danielquinn/paperless/pull/352 .. _#352: https://github.com/the-paperless-project/paperless/pull/352
.. _#354: https://github.com/danielquinn/paperless/issues/354 .. _#354: https://github.com/the-paperless-project/paperless/issues/354
.. _#371: https://github.com/danielquinn/paperless/issues/371 .. _#371: https://github.com/the-paperless-project/paperless/issues/371
.. _#374: https://github.com/danielquinn/paperless/pull/374 .. _#374: https://github.com/the-paperless-project/paperless/pull/374
.. _#375: https://github.com/danielquinn/paperless/pull/375 .. _#375: https://github.com/the-paperless-project/paperless/pull/375
.. _#376: https://github.com/danielquinn/paperless/pull/376 .. _#376: https://github.com/the-paperless-project/paperless/pull/376
.. _#383: https://github.com/danielquinn/paperless/pull/383 .. _#383: https://github.com/the-paperless-project/paperless/pull/383
.. _#384: https://github.com/danielquinn/paperless/issues/384 .. _#384: https://github.com/the-paperless-project/paperless/issues/384
.. _#386: https://github.com/danielquinn/paperless/issues/386 .. _#386: https://github.com/the-paperless-project/paperless/issues/386
.. _#387: https://github.com/danielquinn/paperless/pull/387 .. _#387: https://github.com/the-paperless-project/paperless/pull/387
.. _#391: https://github.com/danielquinn/paperless/pull/391 .. _#391: https://github.com/the-paperless-project/paperless/pull/391
.. _#390: https://github.com/danielquinn/paperless/pull/390 .. _#390: https://github.com/the-paperless-project/paperless/pull/390
.. _#392: https://github.com/danielquinn/paperless/issues/392 .. _#392: https://github.com/the-paperless-project/paperless/issues/392
.. _#393: https://github.com/danielquinn/paperless/issues/393 .. _#393: https://github.com/the-paperless-project/paperless/issues/393
.. _#395: https://github.com/danielquinn/paperless/pull/395 .. _#395: https://github.com/the-paperless-project/paperless/pull/395
.. _#394: https://github.com/danielquinn/paperless/issues/394 .. _#394: https://github.com/the-paperless-project/paperless/issues/394
.. _#396: https://github.com/danielquinn/paperless/pull/396 .. _#396: https://github.com/the-paperless-project/paperless/pull/396
.. _#399: https://github.com/danielquinn/paperless/pull/399 .. _#399: https://github.com/the-paperless-project/paperless/pull/399
.. _#400: https://github.com/danielquinn/paperless/pull/400 .. _#400: https://github.com/the-paperless-project/paperless/pull/400
.. _#401: https://github.com/danielquinn/paperless/pull/401 .. _#401: https://github.com/the-paperless-project/paperless/pull/401
.. _#405: https://github.com/danielquinn/paperless/pull/405 .. _#405: https://github.com/the-paperless-project/paperless/pull/405
.. _#406: https://github.com/danielquinn/paperless/issues/406 .. _#406: https://github.com/the-paperless-project/paperless/issues/406
.. _#412: https://github.com/danielquinn/paperless/issues/412 .. _#412: https://github.com/the-paperless-project/paperless/issues/412
.. _#413: https://github.com/danielquinn/paperless/pull/413 .. _#413: https://github.com/the-paperless-project/paperless/pull/413
.. _#414: https://github.com/danielquinn/paperless/issues/414 .. _#414: https://github.com/the-paperless-project/paperless/issues/414
.. _#423: https://github.com/danielquinn/paperless/issues/423 .. _#423: https://github.com/the-paperless-project/paperless/issues/423
.. _#433: https://github.com/danielquinn/paperless/issues/433 .. _#433: https://github.com/the-paperless-project/paperless/issues/433
.. _#440: https://github.com/danielquinn/paperless/pull/440 .. _#440: https://github.com/the-paperless-project/paperless/pull/440
.. _#441: https://github.com/danielquinn/paperless/pull/441 .. _#441: https://github.com/the-paperless-project/paperless/pull/441
.. _#442: https://github.com/danielquinn/paperless/pull/442 .. _#442: https://github.com/the-paperless-project/paperless/pull/442
.. _#466: https://github.com/danielquinn/paperless/pull/466 .. _#466: https://github.com/the-paperless-project/paperless/pull/466
.. _#471: https://github.com/danielquinn/paperless/pull/471 .. _#471: https://github.com/the-paperless-project/paperless/pull/471
.. _#475: https://github.com/the-paperless-project/paperless/pull/475
.. _#481: https://github.com/the-paperless-project/paperless/pull/481
.. _#483: https://github.com/the-paperless-project/paperless/pull/483
.. _#484: https://github.com/the-paperless-project/paperless/pull/484
.. _#488: https://github.com/the-paperless-project/paperless/pull/488
.. _#489: https://github.com/the-paperless-project/paperless/pull/489
.. _#492: https://github.com/the-paperless-project/paperless/pull/492
.. _pipenv: https://docs.pipenv.org/ .. _pipenv: https://docs.pipenv.org/
.. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/ .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/

4
docs/contributing.rst
View File

@ -136,6 +136,6 @@ there, with a few small changes, but basically it boils down to:
I'm proud to say that the CoC has never had to be enforced because everyone has I'm proud to say that the CoC has never had to be enforced because everyone has
been awesome, friendly, and professional. been awesome, friendly, and professional.
.. _GitHub: https://github.com/danielquinn/paperless/issues .. _GitHub: https://github.com/the-paperless-project/paperless/issues
.. _very well documented: https://www.python.org/dev/peps/pep-0008/ .. _very well documented: https://www.python.org/dev/peps/pep-0008/
.. _code of conduct: https://github.com/danielquinn/paperless/blob/master/CODE_OF_CONDUCT.md .. _code of conduct: https://github.com/the-paperless-project/paperless/blob/master/CODE_OF_CONDUCT.md

10
docs/extending.rst
View File

@ -8,7 +8,7 @@ managed by way of modifying the code directly and issuing a pull request on
`GitHub`_. However, over time the project has been evolving to be a little `GitHub`_. However, over time the project has been evolving to be a little
more "pluggable" so that users can write their own stuff that talks to it. more "pluggable" so that users can write their own stuff that talks to it.
.. _GitHub: https://github.com/danielquinn/paperless .. _GitHub: https://github.com/the-paperless-project/paperless
.. _extending-parsers: .. _extending-parsers:
@ -106,7 +106,7 @@ The core Paperless functionality is based on this design, so if you want to see
what a parser module should look like, have a look at `parsers.py`_, what a parser module should look like, have a look at `parsers.py`_,
`signals.py`_, and `apps.py`_ in the `paperless_tesseract`_ module. `signals.py`_, and `apps.py`_ in the `paperless_tesseract`_ module.
.. _parsers.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/parsers.py .. _parsers.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/parsers.py
.. _signals.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/signals.py .. _signals.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/signals.py
.. _apps.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/apps.py .. _apps.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/apps.py
.. _paperless_tesseract: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/ .. _paperless_tesseract: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/

1
docs/index.rst
View File

@ -45,5 +45,6 @@ Contents
troubleshooting troubleshooting
contributing contributing
scanners scanners
screenshots
changelog changelog
changelog_jonaswinkler changelog_jonaswinkler

4
docs/requirements.rst
View File

@ -52,7 +52,7 @@ with PDFs. Often this is the case with Apple systems using HomeBrew, but other
Linuxes have been a problem as well. The solution appears to be to install Linuxes have been a problem as well. The solution appears to be to install
ghostscript as well as ImageMagick: ghostscript as well as ImageMagick:
.. _run into problems: https://github.com/danielquinn/paperless/issues/25 .. _run into problems: https://github.com/the-paperless-project/paperless/issues/25
.. code:: bash .. code:: bash
@ -92,7 +92,7 @@ enter it, and install the requirements using the ``requirements.txt`` file:
$ . /path/to/arbitrary/directory/bin/activate $ . /path/to/arbitrary/directory/bin/activate
$ pip install --requirement /path/to/paperless/requirements.txt $ pip install --requirement /path/to/paperless/requirements.txt
Now you're ready to go. Just remember to enter (activate) your virtualenv Now you're ready to go. Just remember to enter (activate) your virtualenv
whenever you want to use Paperless. whenever you want to use Paperless.

4
docs/scanners.rst
View File

@ -17,13 +17,17 @@ that works right for you based on recommentations from other Paperless users.
+---------+----------------+-----+-----+-----+----------------+ +---------+----------------+-----+-----+-----+----------------+
| Brother | `MFC-J6930DW`_ | yes | | | `ayounggun`_ | | Brother | `MFC-J6930DW`_ | yes | | | `ayounggun`_ |
+---------+----------------+-----+-----+-----+----------------+ +---------+----------------+-----+-----+-----+----------------+
| Brother | `MFC-J5910DW`_ | yes | | | `bmsleight`_ |
+---------+----------------+-----+-----+-----+----------------+
| Fujitsu | `ix500`_ | yes | | yes | `eonist`_ | | Fujitsu | `ix500`_ | yes | | yes | `eonist`_ |
+---------+----------------+-----+-----+-----+----------------+ +---------+----------------+-----+-----+-----+----------------+
.. _ADS-1500W: https://www.brother.ca/en/p/ads1500w .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
.. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
.. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
.. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/ .. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/
.. _danielquinn: https://github.com/danielquinn .. _danielquinn: https://github.com/danielquinn
.. _ayounggun: https://github.com/ayounggun .. _ayounggun: https://github.com/ayounggun
.. _bmsleight: https://github.com/bmsleight
.. _eonist: https://github.com/eonist .. _eonist: https://github.com/eonist

16
docs/screenshots.rst Normal file
View File

@ -0,0 +1,16 @@
.. _screenshots:
Screenshots
===========
Once everything is set-up login to paperless using the web front-end
.. image:: ./_static/Screenshot_first_run_login.png
Nice clean interface
.. image:: ./_static/Screenshot_first_logged.png
Some documents loaded in via ftp or using the scanners ftp.
.. image:: ./_static/Screenshot_upload_and_scanned.png

23
docs/setup.rst
View File

@ -8,7 +8,7 @@ basic documentation is in order. If you follow along in this document and
still have trouble, please open an `issue on GitHub`_ so I can fill in the still have trouble, please open an `issue on GitHub`_ so I can fill in the
gaps. gaps.
.. _issue on GitHub: https://github.com/danielquinn/paperless/issues .. _issue on GitHub: https://github.com/the-paperless-project/paperless/issues
.. _setup-download: .. _setup-download:
@ -21,7 +21,7 @@ either by using ``git``:
.. code:: bash .. code:: bash
$ git clone https://github.com/danielquinn/paperless.git $ git clone https://github.com/the-paperless-project/paperless.git
$ cd paperless $ cd paperless
or just download the tarball and go that route: or just download the tarball and go that route:
@ -29,7 +29,7 @@ or just download the tarball and go that route:
.. code:: bash .. code:: bash
$ cd to the directory where you want to run Paperless $ cd to the directory where you want to run Paperless
$ wget https://github.com/danielquinn/paperless/archive/master.zip $ wget https://github.com/the-paperless-project/paperless/archive/master.zip
$ unzip master.zip $ unzip master.zip
$ cd paperless-master $ cd paperless-master
@ -77,12 +77,16 @@ Standard (Bare Metal)
encrypt/decrypt the original documents. Don't worry about defining this encrypt/decrypt the original documents. Don't worry about defining this
if you don't want to use encryption (the default). if you don't want to use encryption (the default).
Note also that if you're using the ``runserver`` as mentioned below, you
should make sure that PAPERLESS_DEBUG="true" or is just commented out as
this is the default.
4. Initialise the SQLite database with ``./manage.py migrate``. 4. Initialise the SQLite database with ``./manage.py migrate``.
5. Create a user for your Paperless instance with 5. Create a user for your Paperless instance with
``./manage.py createsuperuser``. Follow the prompts to create your user. ``./manage.py createsuperuser``. Follow the prompts to create your user.
6. Start the webserver with ``./manage.py runserver <IP>:<PORT>``. 6. Start the webserver with ``./manage.py runserver <IP>:<PORT>``.
If no specifc IP or port are given, the default is ``127.0.0.1:8000`` If no specific IP or port is given, the default is ``127.0.0.1:8000`` also
also known as http://localhost:8000/. known as http://localhost:8000/.
You should now be able to visit your (empty) installation at You should now be able to visit your (empty) installation at
`Paperless webserver`_ or whatever you chose before. You can login with the `Paperless webserver`_ or whatever you chose before. You can login with the
user/pass you created in #5. user/pass you created in #5.
@ -143,6 +147,15 @@ Docker Method
instructions in comments in the file. The only change that is a hard instructions in comments in the file. The only change that is a hard
requirement is to specify where the consumption directory should requirement is to specify where the consumption directory should
mount.[#dockercomposeyml]_ mount.[#dockercomposeyml]_
.. caution::
If you are using NFS mounts for the consume directory you also need to
change the command to turn off inotify as it doesn't work with NFS
`command: ["document_consumer", "--no-inotify"]`
5. Modify ``docker-compose.env`` and adapt the following environment variables: 5. Modify ``docker-compose.env`` and adapt the following environment variables:
``PAPERLESS_PASSPHRASE`` ``PAPERLESS_PASSPHRASE``

2
docs/troubleshooting.rst
View File

@ -72,4 +72,4 @@ with a DPI of 300, then merging the images into the single PDF with
For more information on this and situations like it, you should take a look For more information on this and situations like it, you should take a look
at `Issue #118`_ as that's where this tip originated. at `Issue #118`_ as that's where this tip originated.
.. _Issue #118: https://github.com/danielquinn/paperless/issues/118 .. _Issue #118: https://github.com/the-paperless-project/paperless/issues/118

59
docs/utilities.rst
View File

@ -216,3 +216,62 @@ 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 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. a document.
.. _utilities-encyption:
Enabling Encrpytion
-------------------
Let's say you've imported a few documents to play around with paperless and now
you are using it more seriously and want to enable encryption of your files.
.. utilities-encryption-howto:
Basic Syntax
.............
Again we'll use the ``manage.py`` script, passing ``change_storage_type``:
.. code:: bash
$ /path/to/paperless/src/manage.py change_storage_type --help
usage: manage.py change_storage_type [-h] [--version] [-v {0,1,2,3}]
[--settings SETTINGS]
[--pythonpath PYTHONPATH] [--traceback]
[--no-color] [--passphrase PASSPHRASE]
{gpg,unencrypted} {gpg,unencrypted}
This is how you migrate your stored documents from an encrypted state to an
unencrypted one (or vice-versa)
positional arguments:
{gpg,unencrypted} The state you want to change your documents from
{gpg,unencrypted} The state you want to change your documents to
optional arguments:
--passphrase PASSPHRASE
If PAPERLESS_PASSPHRASE isn't set already, you need to
specify it here
Enabling Encryption
...................
Basic usage to enable encryption of your document store (**USE A MORE SECURE PASSPHRASE**):
(Note: If ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)
.. code:: bash
$ /path/to/paperless/src/manage.py change_storage_type [--passphrase SECR3TP4SSPHRA$E] unencrypted gpg
Disabling Encryption
....................
Basic usage to enable encryption of your document store:
(Note: Again, if ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)
.. code:: bash
$ /path/to/paperless/src/manage.py change_storage_type [--passphrase SECR3TP4SSPHRA$E] gpg unencrypted

5
paperless.conf.example
View File

@ -78,7 +78,7 @@ PAPERLESS_EMAIL_SECRET=""
# Controls whether django's debug mode is enabled. Disable this on production # Controls whether django's debug mode is enabled. Disable this on production
# systems. Debug mode is enabled by default. # systems. Debug mode is enabled by default.
PAPERLESS_DEBUG="false" #PAPERLESS_DEBUG="true"
# Paperless can be instructed to attempt to encrypt your PDF files with GPG # Paperless can be instructed to attempt to encrypt your PDF files with GPG
@ -264,6 +264,9 @@ PAPERLESS_DEBUG="false"
# Convert (part of the ImageMagick suite) # Convert (part of the ImageMagick suite)
#PAPERLESS_CONVERT_BINARY=/usr/bin/convert #PAPERLESS_CONVERT_BINARY=/usr/bin/convert
# Ghostscript
#PAPERLESS_GS_BINARY = /usr/bin/gs
# Unpaper # Unpaper
#PAPERLESS_UNPAPER_BINARY=/usr/bin/unpaper #PAPERLESS_UNPAPER_BINARY=/usr/bin/unpaper

2
presentation/index.html
View File

@ -177,7 +177,7 @@
<h2>Fork Me</h2> <h2>Fork Me</h2>
<p> <p>
<i class="fa fa-github"></i> &nbsp; <i class="fa fa-github"></i> &nbsp;
<a class="nocolour" href="https://github.com/danielquinn/paperless">https://github.com/danielquinn/paperless</a> <a class="nocolour" href="https://github.com/the-paperless-project/paperless">https://github.com/the-paperless-project/paperless</a>
</p> </p>
<img src="img/repo.svg" style="width: 300px;" /><br /> <img src="img/repo.svg" style="width: 300px;" /><br />
</section> </section>

80
requirements.txt
View File

@ -4,80 +4,70 @@ apipkg==1.5
atomicwrites==1.2.1 atomicwrites==1.2.1
attrs==18.2.0 attrs==18.2.0
babel==2.6.0 babel==2.6.0
backcall==0.1.0 certifi==2018.11.29
certifi==2018.10.15
chardet==3.0.4 chardet==3.0.4
coverage==4.5.1 coverage==4.5.2
coveralls==1.5.1 coveralls==1.5.1
dateparser==0.7.0 dateparser==0.7.0
decorator==4.3.0
django-cors-headers==2.4.0 django-cors-headers==2.4.0
django-crispy-forms==1.7.2 django-crispy-forms==1.7.2
django-extensions==2.1.3 django-extensions==2.1.4
django-filter==2.0.0 django-filter==2.1.0
django==2.0.9 django==2.0.10
djangorestframework==3.9.0 djangoql==0.12.3
djangorestframework==3.9.1
docopt==0.6.2 docopt==0.6.2
docutils==0.14 docutils==0.14
execnet==1.5.0 execnet==1.5.0
factory-boy==2.11.1 factory-boy==2.11.1
faker==0.9.2 faker==1.0.2
filelock==3.0.10 filelock==3.0.10
filemagic==1.6 filemagic==1.6
fuzzywuzzy[speedup]==0.15.0 fuzzywuzzy[speedup]==0.15.0
gunicorn==19.9.0 gunicorn==19.9.0
idna==2.7 idna==2.8
imagesize==1.1.0 imagesize==1.1.0
inotify-simple==1.1.8 inotify-simple==1.1.8; sys_platform == 'linux'
ipython-genutils==0.2.0
ipython==7.1.1
jedi==0.13.1
jinja2==2.10 jinja2==2.10
langdetect==1.0.7 langdetect==1.0.7
markupsafe==1.0
more-itertools==4.3.0
numpy==1.15.1 numpy==1.15.1
packaging==18.0 markupsafe==1.1.0
parso==0.3.1 more-itertools==5.0.0
packaging==19.0
pdftotext==2.1.1 pdftotext==2.1.1
pexpect==4.6.0 pillow==5.4.1
pickleshare==0.7.5 pluggy==0.8.1
pillow==5.3.0 ply==3.11
pluggy==0.8.0 psycopg2==2.7.7
psycopg2==2.7.6.1
prompt-toolkit==2.0.7
ptyprocess==0.6.0
py==1.7.0 py==1.7.0
pycodestyle==2.4.0 pycodestyle==2.4.0
pygments==2.2.0 pygments==2.3.1
pyocr==0.5.3 pyocr==0.5.3
pyparsing==2.3.0 pyparsing==2.3.1
pytest-cov==2.6.0 pytest-cov==2.6.1
pytest-django==3.4.3 pytest-django==3.4.5
pytest-env==0.6.2 pytest-env==0.6.2
pytest-forked==0.2 pytest-forked==1.0.1
pytest-sugar==0.9.1 pytest-sugar==0.9.2
pytest-xdist==1.24.0 pytest-xdist==1.26.0
pytest==3.9.3 pytest==4.1.1
python-dateutil==2.7.5 python-dateutil==2.7.5
python-dotenv==0.9.1
python-gnupg==0.4.3
python-levenshtein==0.12.0 ; extra == 'speedup'
pytz==2018.7
regex==2018.11.2
requests==2.20.0
six==1.11.0
scikit-learn==0.19.2 scikit-learn==0.19.2
scipy==1.1.0 scipy==1.1.0
python-dotenv==0.10.1
python-gnupg==0.4.4
python-levenshtein==0.12.0
pytz==2018.9
regex==2019.1.24
requests==2.21.0
six==1.12.0
snowballstemmer==1.2.1 snowballstemmer==1.2.1
sphinx==1.8.1 sphinx==1.8.3
sphinxcontrib-websupport==1.1.0 sphinxcontrib-websupport==1.1.0
termcolor==1.1.0 termcolor==1.1.0
text-unidecode==1.2 text-unidecode==1.2
toml==0.10.0 toml==0.10.0
tox==3.5.3 tox==3.7.0
traitlets==4.3.2
tzlocal==1.5.1 tzlocal==1.5.1
urllib3==1.24.1 urllib3==1.24.1
virtualenv==16.1.0 virtualenv==16.3.0
wcwidth==0.1.7

2
scripts/docker-entrypoint.sh
View File

@ -82,7 +82,7 @@ install_languages() {
if apk info -e "$pkg" > /dev/null 2>&1; then if apk info -e "$pkg" > /dev/null 2>&1; then
continue continue
fi fi
if ! apk info "$pkg" > /dev/null 2>&1; then if ! apk --no-cache info "$pkg" > /dev/null 2>&1; then
continue continue
fi fi

3
src/documents/admin.py
View File

@ -11,6 +11,7 @@ from django.urls import reverse
from django.utils.html import format_html, format_html_join from django.utils.html import format_html, format_html_join
from django.utils.http import urlquote from django.utils.http import urlquote
from django.utils.safestring import mark_safe from django.utils.safestring import mark_safe
from djangoql.admin import DjangoQLSearchMixin
from documents.actions import ( from documents.actions import (
add_tag_to_selected, add_tag_to_selected,
@ -186,7 +187,7 @@ class DocumentTypeAdmin(CommonAdmin):
document_count.admin_order_field = "document_count" document_count.admin_order_field = "document_count"
class DocumentAdmin(CommonAdmin): class DocumentAdmin(DjangoQLSearchMixin, CommonAdmin):
class Media: class Media:
css = { css = {

6
src/documents/mail.py
View File

@ -216,7 +216,11 @@ class MailFetcher(Loggable):
return r return r
def _connect(self): def _connect(self):
self._connection = imaplib.IMAP4_SSL(self._host, self._port) try:
self._connection = imaplib.IMAP4_SSL(self._host, self._port)
except OSError as e:
msg = "Problem connecting to {}: {}".format(self._host, e.strerror)
raise MailFetcherError(msg)
def _login(self): def _login(self):

3
src/documents/management/commands/change_storage_type.py
View File

@ -75,7 +75,8 @@ class Command(BaseCommand):
for document in encrypted_files: for document in encrypted_files:
print(coloured("Decrypting {}".format(document), "green")) print(coloured("Decrypting {}".format(
document).encode('utf-8'), "green"))
old_paths = [document.source_path, document.thumbnail_path] old_paths = [document.source_path, document.thumbnail_path]
raw_document = GnuPG.decrypted(document.source_file, passphrase) raw_document = GnuPG.decrypted(document.source_file, passphrase)

21
src/documents/serialisers.py
View File

@ -7,14 +7,24 @@ class CorrespondentSerializer(serializers.HyperlinkedModelSerializer):
class Meta: class Meta:
model = Correspondent model = Correspondent
fields = ("id", "slug", "name", "automatic_classification") fields = (
"id",
"slug",
"name",
"automatic_classification"
)
class DocumentTypeSerializer(serializers.HyperlinkedModelSerializer): class DocumentTypeSerializer(serializers.HyperlinkedModelSerializer):
class Meta: class Meta:
model = DocumentType model = DocumentType
fields = ("id", "slug", "name", "automatic_classification") fields = (
"id",
"slug",
"name",
"automatic_classification"
)
class TagSerializer(serializers.HyperlinkedModelSerializer): class TagSerializer(serializers.HyperlinkedModelSerializer):
@ -22,7 +32,12 @@ class TagSerializer(serializers.HyperlinkedModelSerializer):
class Meta: class Meta:
model = Tag model = Tag
fields = ( fields = (
"id", "slug", "name", "colour", "automatic_classification") "id",
"slug",
"name",
"colour",
"automatic_classification"
)
class CorrespondentField(serializers.HyperlinkedRelatedField): class CorrespondentField(serializers.HyperlinkedRelatedField):

5
src/documents/views.py
View File

@ -2,6 +2,7 @@ from django.http import HttpResponse, HttpResponseBadRequest
from django.views.generic import DetailView, FormView, TemplateView from django.views.generic import DetailView, FormView, TemplateView
from django_filters.rest_framework import DjangoFilterBackend from django_filters.rest_framework import DjangoFilterBackend
from django.conf import settings from django.conf import settings
from django.utils import cache
from paperless.db import GnuPG from paperless.db import GnuPG
from paperless.mixins import SessionOrBasicAuthMixin from paperless.mixins import SessionOrBasicAuthMixin
@ -63,10 +64,12 @@ class FetchView(SessionOrBasicAuthMixin, DetailView):
} }
if self.kwargs["kind"] == "thumb": if self.kwargs["kind"] == "thumb":
return HttpResponse( response = HttpResponse(
self._get_raw_data(self.object.thumbnail_file), self._get_raw_data(self.object.thumbnail_file),
content_type=content_types[Document.TYPE_PNG] content_type=content_types[Document.TYPE_PNG]
) )
cache.patch_cache_control(response, max_age=31536000, private=True)
return response
response = HttpResponse( response = HttpResponse(
self._get_raw_data(self.object.source_file), self._get_raw_data(self.object.source_file),

4
src/paperless/settings.py
View File

@ -83,6 +83,7 @@ INSTALLED_APPS = [
"rest_framework", "rest_framework",
"crispy_forms", "crispy_forms",
"django_filters", "django_filters",
"djangoql",
] ]
@ -270,6 +271,9 @@ CONVERT_TMPDIR = os.getenv("PAPERLESS_CONVERT_TMPDIR")
CONVERT_MEMORY_LIMIT = os.getenv("PAPERLESS_CONVERT_MEMORY_LIMIT") CONVERT_MEMORY_LIMIT = os.getenv("PAPERLESS_CONVERT_MEMORY_LIMIT")
CONVERT_DENSITY = os.getenv("PAPERLESS_CONVERT_DENSITY") CONVERT_DENSITY = os.getenv("PAPERLESS_CONVERT_DENSITY")
# Ghostscript
GS_BINARY = os.getenv("PAPERLESS_GS_BINARY", "gs")
# OptiPNG # OptiPNG
OPTIPNG_BINARY = os.getenv("PAPERLESS_OPTIPNG_BINARY", "optipng") OPTIPNG_BINARY = os.getenv("PAPERLESS_OPTIPNG_BINARY", "optipng")

42
src/paperless_tesseract/parsers.py
View File

@ -29,6 +29,7 @@ class RasterisedDocumentParser(DocumentParser):
""" """
CONVERT = settings.CONVERT_BINARY CONVERT = settings.CONVERT_BINARY
GHOSTSCRIPT = settings.GS_BINARY
DENSITY = settings.CONVERT_DENSITY if settings.CONVERT_DENSITY else 300 DENSITY = settings.CONVERT_DENSITY if settings.CONVERT_DENSITY else 300
THREADS = int(settings.OCR_THREADS) if settings.OCR_THREADS else None THREADS = int(settings.OCR_THREADS) if settings.OCR_THREADS else None
UNPAPER = settings.UNPAPER_BINARY UNPAPER = settings.UNPAPER_BINARY
@ -47,13 +48,40 @@ class RasterisedDocumentParser(DocumentParser):
out_path = os.path.join(self.tempdir, "convert.png") out_path = os.path.join(self.tempdir, "convert.png")
# Run convert to get a decent thumbnail # Run convert to get a decent thumbnail
run_convert( try:
self.CONVERT, run_convert(
"-scale", "500x5000", self.CONVERT,
"-alpha", "remove", "-scale", "500x5000",
"{}[0]".format(self.document_path), "-alpha", "remove",
out_path "-strip", "-trim",
) "{}[0]".format(self.document_path),
out_path
)
except ParseError:
# if convert fails, fall back to extracting
# the first PDF page as a PNG using Ghostscript
self.log(
"warning",
"Thumbnail generation with ImageMagick failed, "
"falling back to Ghostscript."
)
gs_out_path = os.path.join(self.tempdir, "gs_out.png")
cmd = [self.GHOSTSCRIPT,
"-q",
"-sDEVICE=pngalpha",
"-o", gs_out_path,
self.document_path]
if not subprocess.Popen(cmd).wait() == 0:
raise ParseError("Thumbnail (gs) failed at {}".format(cmd))
# then run convert on the output from gs
run_convert(
self.CONVERT,
"-scale", "500x5000",
"-alpha", "remove",
"-strip", "-trim",
gs_out_path,
out_path
)
return out_path return out_path

3
src/tox.ini
View File

@ -17,6 +17,5 @@ deps=pycodestyle
[testenv:doc] [testenv:doc]
deps = deps =
-r{toxinidir}/../requirements.txt -r {toxinidir}/../requirements.txt
sphinx
commands=sphinx-build -b html ../docs ../docs/_build -W commands=sphinx-build -b html ../docs ../docs/_build -W