File: README.markdown

package info (click to toggle)
paperwork 1.3.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 11,060 kB
  • sloc: python: 19,833; makefile: 470; sh: 274; xml: 114
file content (128 lines) | stat: -rw-r--r-- 4,287 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# Paperwork - [openpaper.work](https://openpaper.work/)


## Description

Paperwork is a personal document manager. It manages scanned documents and PDFs.

It's designed to be easy and fast to use. The idea behind Paperwork
is "scan & forget": You can just scan a new document and
forget about it until the day you need it again.

In other words, let the machine do most of the work for you.


## Screenshots

### Main Window

<a href="http://youtu.be/RMazTTM6ltg">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/main_window.png" width="447" height="280" />
</a>


### Search Suggestions

<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/suggestions.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/suggestions.png" width="155" height="313" />
</a>


### Labels

<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/multiple_labels.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/multiple_labels.png" width="187" height="262" />
</a>


### Settings window

<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/settings.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/1.0/settings.png" width="443" height="286" />
</a>


## Main features

* Scan
* Automatic detection of page orientation
* OCR
* Document labels
* Automatic guessing of the labels to apply on new documents
* Search
* Keyword suggestions
* Quick edit of scans
* PDF support

Papers are organized into documents. Each document contains pages.


## Installation

Note regarding updates:
If you're upgrading from a previous version installed with pip, it is strongly recommended you uninstall
it first before installing the new version.

* GNU/Linux:
  * Distribution-specific methods:
    * [GNU/Linux Archlinux](doc/install.archlinux.markdown)
    * [GNU/Linux Debian](doc/install.debian.markdown)
    * [GNU/Linux Fedora](doc/install.fedora.markdown)
    * [GNU/Linux Gentoo](doc/install.gentoo.markdown)
    * [GNU/Linux Ubuntu](doc/install.debian.markdown)
  * [Using Flatpak](flatpak/README.markdown)
  * [GNU/Linux Development](doc/install.devel.markdown)
* Microsoft Windows:
  * [Installation](https://openpaper.work)
  * [Development](doc/devel.windows.markdown)


## Uninstall

### GNU/Linux

[Doc](doc/uninstall.linux.markdown)

### Windows

If you used the installer from [OpenPaper](https://openpaper.work), Paperwork can be uninstalled like any
other Windows application (something like Control Panel --> Applications --> Uninstall).

If you installed it manually (for development), you can follow the same process than for
[GNU/Linux](doc/uninstall.linux.markdown)


## Donate

<a href="https://openpaper.work/download#donate">Help us help you ! ;-)</a>


## Contact/Help

* [Extra documentation / FAQ / Tips / Wiki](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/)
* [Forum](https://forum.openpaper.work/)
* [IRC](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact#irc)
* [Bug tracker](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact#bug-trackers)
* [Contributing to Paperwork](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contributing)


## Details

It mainly uses:

* [Sane](http://www.sane-project.org/)/[Libinsane](https://gitlab.gnome.org/World/OpenPaperwork/libinsane#readme): To scan the pages
* [Tesseract](https://github.com/tesseract-ocr)/[Pyocr](https://gitlab.gnome.org/World/OpenPaperwork/pyocr#readme): To extract the words from the pages (OCR)
* [GTK](http://www.gtk.org/): For the user interface
* [Whoosh](https://pypi.python.org/pypi/Whoosh/): To index and search documents, and provide keyword suggestions
* [Simplebayes](https://pypi.python.org/pypi/simplebayes/): To guess the labels
* [Pillow](https://pypi.python.org/pypi/Pillow/)/[Libpillowfight](https://gitlab.gnome.org/World/OpenPaperwork/libpillowfight): Image manipulation


## Licence

GPLv3 or later. See COPYING.


## Development

All the information can be found on [the wiki](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis).