README.markdown 4.46 KB
Newer Older
1
# Paperwork - [openpaper.work](https://openpaper.work/)
2

3

4
## Description
5

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

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

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

14

15
## Screenshots
16

Jerome Flesch's avatar
Jerome Flesch committed
17
### Main Window
18

Jerome Flesch's avatar
Jerome Flesch committed
19 20
<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/main_window.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/main_window.png" width="447" height="280" />
21
</a>
22

Jerome Flesch's avatar
Jerome Flesch committed
23

24
### Search Suggestions
25

Jerome Flesch's avatar
Jerome Flesch committed
26 27
<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/suggestions.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/suggestions.png" width="155" height="313" />
28 29
</a>

Jerome Flesch's avatar
Jerome Flesch committed
30

31 32
### Labels

Jerome Flesch's avatar
Jerome Flesch committed
33 34
<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/multiple_labels.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/multiple_labels.png" width="187" height="262" />
35 36
</a>

Jerome Flesch's avatar
Jerome Flesch committed
37

38 39
### Settings window

Jerome Flesch's avatar
Jerome Flesch committed
40 41
<a href="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/settings.png">
  <img src="https://gitlab.gnome.org/World/OpenPaperwork/paperwork-screenshots/raw/master/2.0/settings.png" width="443" height="286" />
42 43
</a>

44 45 46
### Command line

![Command line](http://storage.sbg.cloud.ovh.net/v1/AUTH_6c4273c748b243c58df3f6942075e0c9/gitlab.gnome.org/paperwork-shell/search.gif)
47

48
## Main features
49

50 51 52 53 54 55 56 57 58
* 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
59
* [Kick-ass command line interface](/paperwork-shell/README.markdown)
60

Jerome Flesch's avatar
Jerome Flesch committed
61 62
Papers are organized into documents. Each document contains pages.

Jerome Flesch's avatar
Jerome Flesch committed
63

64
## Installation
65

66 67 68 69
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.

70 71 72 73 74 75 76
* 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)
77
  * [Using Flatpak](doc/install.flatpak.markdown)
78 79
  * [GNU/Linux Development](doc/install.devel.markdown)
* Microsoft Windows:
80
  * [Installer](https://openpaper.work)
81
  * [Development](doc/devel.windows.markdown)
82

Jerome Flesch's avatar
Jerome Flesch committed
83

84
## Uninstallation
85 86 87 88 89 90 91 92 93 94 95 96 97 98

### 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)


Jerome Flesch's avatar
Jerome Flesch committed
99 100
## Donate

Jordan Christiansen's avatar
Jordan Christiansen committed
101
[Help us help you ! ;-)](https://www.patreon.com/openpaper)
Jerome Flesch's avatar
Jerome Flesch committed
102 103


104 105
## Contact/Help

106
* [Extra documentation / FAQ / Tips / Wiki](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/)
107 108 109
* [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)
110
* [Contributing to Paperwork](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contributing)
111 112 113 114 115 116


## Details

It mainly uses:

117
* [Sane](http://www.sane-project.org/)/[Libinsane](https://gitlab.gnome.org/World/OpenPaperwork/libinsane#readme): To scan the pages
118
* [Tesseract](https://github.com/tesseract-ocr)/[Pyocr](https://gitlab.gnome.org/World/OpenPaperwork/pyocr#readme): To extract the words from the pages (OCR)
119 120 121
* [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
122
* [Pillow](https://pypi.python.org/pypi/Pillow/)/[Libpillowfight](https://gitlab.gnome.org/World/OpenPaperwork/libpillowfight): Image manipulation
123 124 125 126 127 128 129


## Licence

GPLv3 or later. See COPYING.


130
## Development
131

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