pdfcomposer


Namepdfcomposer JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/gumshoe00/gumshoe_pdf_composer
SummaryComposes one PDF from the given pdf files, in the given sequence.
upload_time2022-12-19 12:23:29
maintainerGumshoe Media Inc.
docs_urlNone
authorsmikhail
requires_python>=3.7
licenseMIT 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
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Gumshoe PDF Composer


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


## Installation


To install, run `pip install pdfcomposer`


## Examples

### Call the default from the command line

```shell

pdfcomposer --outputer index

# index outputers  
# ('compose', 'index') 

```

### Call a plugin (compose) 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 import Api

composer = Api()


# index
args = []

kws = dict(path='index')

result = composer(*args, **kws)

print(result)



# compose
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 = composer(*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


```





            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/gumshoe00/gumshoe_pdf_composer",
    "name": "pdfcomposer",
    "maintainer": "Gumshoe Media Inc.",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "gumshoe.media.inc@gmail.com",
    "keywords": "PDF,composer,python3",
    "author": "smikhail",
    "author_email": "gumshoe.media.inc@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/0e/f0/66eed9d4ea0004f12ca4782df7e14e728e7545fb421a6ca7f24293276226/pdfcomposer-1.0.0.tar.gz",
    "platform": null,
    "description": "# Gumshoe PDF Composer\n\n\nComposes one PDF from the given pdf files, in the given sequence,\nthen writes it to the given outfile.\n\n\n## Installation\n\n\nTo install, run `pip install pdfcomposer`\n\n\n## Examples\n\n### Call the default from the command line\n\n```shell\n\npdfcomposer --outputer index\n\n# index outputers  \n# ('compose', 'index') \n\n```\n\n### Call a plugin (compose) from the command line\n\n```shell\n\npdfcomposer --outputer compose \\\n  --args 'outfile.pdf' 'infile1.pdf' 'infile2.pdf'\\\n  --kwargs title=\"My PDF\" author=\"John Doe\" subject=\"My first PDF\" creator=\"John Doe\"\n\n# composes a PDF with the content of infile1.pdf then infile2.pdf\n# sets the PDF info with the given kwargs\n# writes the PDF to ./outfile.pdf\n\n```\n\n### From a script \n\n\n```python\n\n\nfrom pdfcomposer import Api\n\ncomposer = Api()\n\n\n# index\nargs = []\n\nkws = dict(path='index')\n\nresult = composer(*args, **kws)\n\nprint(result)\n\n\n\n# compose\nargs = ['./outfile.pdf', './infile1.pdf', './infile2.pdf']\n\nkws = dict(path='compose',\n           title=\"My PDF\",\n           author=\"John Doe\",\n           subject=\"My first PDF\",\n           creator=\"John Doe\")\n\nresult = composer(*args, **kws)\n\nprint(result)\n\n\n# composes a PDF with the content of infile1.pdf then infile2.pdf\n# sets the PDF info with the given kwargs\n# writes the PDF to ./outfile.pdf\n\n\n```\n\n\n\n\n",
    "bugtrack_url": null,
    "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.         ",
    "summary": "Composes one PDF from the given pdf files, in the given sequence.",
    "version": "1.0.0",
    "split_keywords": [
        "pdf",
        "composer",
        "python3"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "940688d29a9efc783bfddd0939a7ae19",
                "sha256": "c0bdac1c87c116226e3803155555840674856fc8c554ca8e08ce0a4d51960db3"
            },
            "downloads": -1,
            "filename": "pdfcomposer-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "940688d29a9efc783bfddd0939a7ae19",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 3415,
            "upload_time": "2022-12-19T12:23:27",
            "upload_time_iso_8601": "2022-12-19T12:23:27.994655Z",
            "url": "https://files.pythonhosted.org/packages/ee/93/284abceead8a6dceac628074d97cc67cf515c159b1ed2c3f0ced942280d1/pdfcomposer-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "787cfa52db2b641aea4f318b23a19dc9",
                "sha256": "c72670c89a63511cf9db3aa06c39e9aab323b5bf8dea963fb3c509226c8375f8"
            },
            "downloads": -1,
            "filename": "pdfcomposer-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "787cfa52db2b641aea4f318b23a19dc9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2577,
            "upload_time": "2022-12-19T12:23:29",
            "upload_time_iso_8601": "2022-12-19T12:23:29.472845Z",
            "url": "https://files.pythonhosted.org/packages/0e/f0/66eed9d4ea0004f12ca4782df7e14e728e7545fb421a6ca7f24293276226/pdfcomposer-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-19 12:23:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "gumshoe00",
    "github_project": "gumshoe_pdf_composer",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "pdfcomposer"
}
        
Elapsed time: 0.02887s