Mercurial > hgrepos > Python2 > pdfautonup

annotate README.rst @ 1:d0832175b1b2 upstream

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ADD: the original upstream of pdfautonup v1.12.1
author Franz Glasner <fzglas.hg@dom66.de>
date Tue, 16 Sep 2025 13:39:50 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 pdfautonup 🍳 n-up the pages of pdf files, guessing layout
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2 ==========================================================
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 *Check out my other PDF tools:* `pdfimpose <https://framagit.org/spalax/pdfimpose>`__ | `dummypdf <https://framagit.org/spalax/dummypdf>`__. *This tool can be used online at:* `https://pdfimpose.it <https://pdfimpose.it?layout=pdfautonup>`__
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Fit as much pages as possible, from some PDF files to a 'n-up' PDF file of a given page size, guessing the layout.
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8 Examples
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 --------
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 With the default paper size being A4, ``pdfautonup`` on:
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13 - `trigo.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/trigo.pdf?inline=false>`_ gives `trigo-nup.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/trigo-nup.pdf?inline=false>`_
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 - `pcb.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/pcb.pdf?inline=false>`_ gives `pcb-nup.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/pcb-nup.pdf?inline=false>`_
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 - `three-pages.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/three-pages.pdf?inline=false>`_ gives `three-pages-nup.pdf <https://framagit.org/spalax/pdfautonup/-/raw/main/examples/three-pages-nup.pdf?inline=false>`_
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 See the documentation for the full command lines used to generate those examples.
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19 What's new?
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 -----------
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 See `changelog <https://git.framasoft.org/spalax/pdfautonup/blob/main/CHANGELOG.md>`_.
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 Download and install
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25 --------------------
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 See the end of list for a (quick and dirty) Debian package.
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29 * From sources:
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31 * Download: https://pypi.python.org/pypi/pdfautonup
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 * Install (in a `virtualenv`, if you do not want to mess with your distribution installation system)::
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 python3 setup.py install
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 * From pip::
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 pip install pdfautonup
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
39
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
40 Note: If `PyMuPDF <https://github.com/pymupdf/PyMuPDF>`_ can be installed, you can use::
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 pip install pdfautonup[pymupdf]
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
43
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
44 This will change the python library used to read and write PDF files (`PyMuPDF <https://github.com/pymupdf/PyMuPDF>`_ instead of `PyPDF <https://pypi.org/project/pypdf/>`_), to make pdfautonup faster.
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 * Quick and dirty Debian (and Ubuntu?) package
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
47
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
48 This requires `stdeb <https://github.com/astraw/stdeb>`_ (and `setuptools-scm <https://pypi.org/project/setuptools-scm/>`_) to be installed::
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 python3 setup.py --command-packages=stdeb.command bdist_deb
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51 sudo dpkg -i deb_dist/pdfautonup-<VERSION>_all.deb
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
53 Documentation
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
54 -------------
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 * The compiled documentation is available on `readthedocs <http://pdfautonup.readthedocs.io>`_
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
57
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
58 * To compile it from source, download and run::
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
d0832175b1b2 ADD: the original upstream of pdfautonup v1.12.1
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 cd doc && make html