Metadata-Version: 2.1
Name: pdfcomposer-compose
Version: 1.0.1
Summary: Composes one PDF from the given pdf files, in the given sequence.
Home-page: https://github.com/gumshoe00/pdfcomposer-compose
Author: smikhail
Author-email: gumshoe.media.inc@gmail.com
Maintainer: Gumshoe Media Inc.
Maintainer-email: gumshoe.media.inc@gmail.com
License: MIT
        
        Copyright 2022 Gumshoe Media Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        
        
        
        
        
        
        
        
Keywords: PDF,composer,python3
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Compose - Gumshoe PDF Composer Plugin


Composes one PDF from the given pdf files, in the given sequence,
then writes it to the given outfile path.


## Installation


To install, run `pip install pdfcomposer-compose` 

(OR `pip install "pdfcomposer-compose"`)


## Examples

### From the command line
```shell

pdfcomposer --outputer compose \
  --args 'outfile.pdf' 'infile1.pdf' 'infile2.pdf'\
  --kwargs title="My PDF" author="John Doe" subject="My first PDF" creator="John Doe"

# composes a PDF with the content of infile1.pdf then infile2.pdf
# sets the PDF info with the given kwargs
# writes the PDF to ./outfile.pdf

```

### From a script


```python

from pdfcomposer_compose import main

args = ['./outfile.pdf', './infile1.pdf', './infile2.pdf']

kws = dict(path='compose',
           title="My PDF",
           author="John Doe",
           subject="My first PDF",
           creator="John Doe")

result = main(*args, **kws)

print(result)


# composes a PDF with the content of infile1.pdf then infile2.pdf
# sets the PDF info with the given kwargs
# writes the PDF to ./outfile.pdf


```




