README.md 1.86 KB
Newer Older
Kjo's avatar
Kjo committed
1 2
% BookletImposer / pdfimposer
% Achieve some basic imposition on PDF documents
Kjo's avatar
Kjo committed
3 4 5 6 7


What is it ?
============

8 9 10 11 12
Bookletimposer is an utility to achieve some basic imposition on PDF
documents, especially designed to work on booklets.

Bookletimposer is implemented as a commandline and GTK+ interface to pdfimposer,
a reusable python module built on top of pyPdf.
Kjo's avatar
Kjo committed
13

14 15
It was tested on GNU/Linux althought it may work on any systems with a Python
interpreter.
Kjo's avatar
Kjo committed
16

17 18 19
Bookletimposer and pdfimposer are both free software released under the GNU
General Public License, either version 3 or (at your option) any later version.
See COPYING for the full text of the license.
Kjo's avatar
Kjo committed
20 21 22 23 24 25 26 27 28 29


Features
========

- transform linear documents to booklets
- transform booklets to linear documents
- reduce a document to put many on one sheet


Kjö Hansi Glaz's avatar
Kjö Hansi Glaz committed
30 31
Development state
=================
Kjo's avatar
Kjo committed
32

Kjo's avatar
Kjo committed
33
BookletImposer should be quite stable. Thanks to report bugs on
Kjo's avatar
Kjo committed
34
kjo@a4nancy.net.eu.org.
Kjo's avatar
Kjo committed
35 36 37 38 39 40

Dependencies
============

pdfimposer requires:

Kjo's avatar
Kjo committed
41 42
- python3 (>= 3.5)
- pyPdf2 (>= 1.26)
Kjo's avatar
Kjo committed
43

Kjo's avatar
Kjo committed
44 45
BookletImposer also requires:

Kjo's avatar
Kjo committed
46
- PyGObject
Kjo's avatar
Kjo committed
47
- gtk+ (>= 3.22)
Kjo's avatar
Kjo committed
48
- glib
Kjo's avatar
Kjo committed
49 50 51

In addition, the build and installation process requires:

Kjo's avatar
Kjo committed
52
- python3-distutils-extra
Kjo's avatar
Kjo committed
53
- pandoc
Kjo's avatar
Kjo committed
54

Kjo's avatar
Kjo committed
55 56
And to build the website:

Kjo's avatar
Kjo committed
57
- python3-epydoc
Kjo's avatar
Kjo committed
58 59
- xsltproc
- docbook-xsl
Kjo's avatar
Kjo committed
60 61 62 63

Quick installation
==================

Kjo's avatar
Kjo committed
64 65 66 67
Under debian, install the following packages:

    python3-pypdf2 python3-distutils-extra python3-gi gir1.2-gtk-3.0 gir1.2-glib-2.0 pandoc

Kjo's avatar
Kjo committed
68 69 70 71 72 73 74 75 76 77 78 79
Once the tarball downloaded and extracted:

    $ ./setup.py build

Then as root:

    # ./setup.py install


pdfimposer API documentation
============================

Kjo's avatar
Kjo committed
80 81
See generated epydoc documentation (available at
<https://kjo.herbesfolles.org/bookletimposer/api/>)
Kjo's avatar
Kjo committed
82 83 84 85 86


BookletImposer usage
====================

Kjo's avatar
Kjo committed
87
BookletImposer can be launched from the Application view,
Kjo's avatar
Kjo committed
88 89 90 91 92
or with te command:

    $ bookletimposer

Help on command line options is available in the man page.