Metadata-Version: 2.1
Name: pystitcher
Version: 1.0.1
Summary: Stitch together a PDF file from multiple sources in a declarative manner
Home-page: https://github.com/captn3m0/pystitcher
Author: Nemo
Author-email: python@captnemo.in
License: MIT
Project-URL: Documentation, https://github.com/captn3m0/pystitcher/wiki
Project-URL: Source, https://github.com/captn3m0/pystitcher
Project-URL: Changelog, https://github.com/captn3m0/pystitcher/blob/main/CHANGELOG.md
Project-URL: Tracker, https://github.com/captn3m0/pystitcher/issues
Description: ==========
        pystitcher
        ==========
        
        pystitcher stitches your PDF files together, generating nice customizable bookmarks for you using a declarative input in the form of a markdown file. It is written in pure python and uses `PyPDF3 <https://pypi.org/project/PyPDF3/>`_ for reading and writing PDF files.
        
        
        Description
        ===========
        
        pystitcher is a command line tool, with very few cli options::
        
        	usage: pystitcher [-h] [--version] [-v] [--cleanup | --no-cleanup] spine.md output.pdf
        
        	Stitch PDF files together
        
        	positional arguments:
        	  spine.md              Input markdown file
        	  output.pdf            Output PDF file
        
        	optional arguments:
        	  -h, --help            show this help message and exit
        	  --version             show program's version number and exit
        	  -v, --verbose         log more things
        	  --cleanup, --no-cleanup
        	                        Delete temporary files (default: True)
        
        Given this input::
        
        	existing_bookmarks: remove
        	title: Complete Guide to the Personal Data Protection Bill
        	author: Medianama
        	keywords: privacy, surveillance, personal data protection
        	subject: Personal Data Protection Bill
        	# A Complete Guide to the Personal Data Protection Bill
        
        	- [Cover](cover.pdf)
        
        	# The Bills
        
        	- [Personal Data Protection Bill, 2019](1.a.pdf)
        	- [Personal Data Protection Bill, 2018](1.b.pdf)
        
        	# Other key reading material
        
        	- [Srikrishna Committee Report](2.a.pdf)
        	- [Dvara Research's Personal Data Protection Bill](2.b.pdf)
        	- [MP Shashi Tharoor's Data Protection Bill](2.c.pdf)
        	- [MP Jay Panda's Data Protection Bill](2.d.pdf)
        	- [SaveOurPrivacy.in bill](2.e.pdf)
        	- [TRAI recommendations on privacy](2.f1.pdf)
        	- [Comments on TRAI recommendations on privacy](2.f2.pdf)
        
        Will generate a PDF with proper bookmarks:
        
        .. image:: https://i.imgur.com/qPVpZGt.png
        
        And the correct metadata::
        
        	Title:          Complete Guide to the Personal Data Protection Bill
        	Subject:        Personal Data Protection Bill
        	Keywords:       privacy, surveillance, personal data protection
        	Author:         Medianama
        	Creator:        pystitcher/1.0.0
        	Producer:       pystitcher/1.0.0
        
        Configuration options can be specified with Meta data at the top of the file.
        
        +---------------------+--------------------------------------------------------------------------+
        | Option              | Notes                                                                    |
        +=====================+==========================================================================+
        | fit                 | Default fit of the bookmark. Can be overwritten per bookmark             |
        |                     | See `wiki <https://github.com/captn3m0/pystitcher/wiki/Zoom-Levels>`_    |
        |                     | for more details.                                                        |
        +---------------------+--------------------------------------------------------------------------+
        | author              | PDF Author                                                               |
        +---------------------+--------------------------------------------------------------------------+
        | keywords            | PDF Keywords                                                             |
        +---------------------+--------------------------------------------------------------------------+
        | subject             | PDF Subject                                                              |
        +---------------------+--------------------------------------------------------------------------+
        | title               | PDF Title. If left unspecified, first Heading (h1)                       |
        |                     | in the document is used.                                                 |
        +---------------------+--------------------------------------------------------------------------+
        | existing_bookmarks  | What to do with existing bookmarks in individual files.                  |
        |                     | Options are ``keep``, ``flatten``, and ``remove``. See                   |
        |                     | `docs <https://github.com/captn3m0/pystitcher/wiki/Existing-Bookmarks>`_ |
        |                     | for more details.                                                        |
        +---------------------+--------------------------------------------------------------------------+
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Requires-Python: >=3.6
Description-Content-Type: text/x-rst; charset=UTF-8
Provides-Extra: testing
