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
|
## Description
[Paperwork](https://gitlab.gnome.org/World/OpenPaperwork/paperwork#readme) is a GUI to make papers searchable.
This is the backend part of Paperwork. It manages:
- The work directory / Access to the documents
- Indexing
- Searching
- Suggestions
- Import
- Export
There is no GUI here. The GUI is located here: https://gitlab.gnome.org/World/OpenPaperwork/paperwork/tree/master/paperwork-gtk .
Regarding the name "Paperwork", it can refer to both the GUI or the backend. If you want to be specific, you can call the gui "paperwork-gtk" instead of just Paperwork.
## Dependencies
* [Pillow](https://pypi.python.org/pypi/Pillow/): Image manipulation (with JPEG support)
* [Whoosh](https://pypi.python.org/pypi/Whoosh/): To index and search documents, and provide keyword suggestions
* Libpoppler (PDF support)
* Cairo
* Gobject Introspection
## Usage
You can find some examples in scripts/. You can also look at the code of
[Paperwork](https://gitlab.gnome.org/World/OpenPaperwork/paperwork#readme) for
reference.
Here are some snippets:
```py
# TODO(Jflesch): UPDATE
```
## Contact/Help
Developement is strongly related to Paperwork-gui.
* [Mailing-list](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact)
* [Extra documentation / FAQ / Tips / Wiki](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/)
* [Bug trackers](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact)
## Contact
* [Mailing-list](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact)
* [Bug tracker](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis/Contact)
## Licence
GPLv3 or later. See LICENSE.
## Development
Developement is strongly related to Paperwork-gui.
All the information can be found on [the wiki](https://gitlab.gnome.org/World/OpenPaperwork/paperwork/wikis).
|