wkhtmltopdf-api


Namewkhtmltopdf-api JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/royaurelien/wkhtmltopdf-api
SummaryWkhtmltopdf API Wrapper
upload_time2024-08-21 18:06:42
maintainerNone
docs_urlNone
authorAurelien ROY
requires_python>=3.8
licenseBSD 2-clause
keywords
VCS
bugtrack_url
requirements requests
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Wkhtmltopdf API Wrapper

_**wkhtmltopdf-api** Command Line Tool_

![PyPI](https://img.shields.io/pypi/v/wkhtmltopdf-api) ![PyPI](https://img.shields.io/pypi/pyversions/wkhtmltopdf-api)


In short, the script acts as a wrapper for Wkhtmltopdf. It replaces the local binary and transfers the job of generating pdf files to an external api.



## Installation

Install from PyPI:
```bash
pip install wkhtmltopdf-api
```

## Configuration

### Environment vars

  - REPORT_API_URL: str, required


  - REPORT_API_TIMEOUT: seconds, default 300
  - REPORT_API_SIZE_LIMIT: bytes, default 100000000 (100mb)
  - WKHTMLTOPDF_VERSION: str, default 0.12.6


### Usage



Same as wkhtmltopdf, see options : https://wkhtmltopdf.org/usage/wkhtmltopdf.txt

```bash
wkhtmltopdf-api --disable-local-file-access --cookie session_id abcd --quiet --page-size A4 --margin-top 40.0 --dpi 90 --zoom 1.0666666666666667 --header-spacing 35 --margin-left 7.0 --margin-bottom 28.0 --margin-right 7.0 --orientation Portrait --header-html /tmp/report.header.tmp.xxx.html --footer-html /tmp/report.footer.tmp.xxx.html /tmp/report.body.tmp.xxx.html /tmp/report.tmp.xxx.pdf

```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/royaurelien/wkhtmltopdf-api",
    "name": "wkhtmltopdf-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "Aurelien ROY",
    "author_email": "roy.aurelien@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/7c/82/d08c5e2163b14e5bfe4b719cc7694a701c67191b8ad3801fd6ccc716bfb4/wkhtmltopdf_api-0.1.0.tar.gz",
    "platform": null,
    "description": "\n# Wkhtmltopdf API Wrapper\n\n_**wkhtmltopdf-api** Command Line Tool_\n\n![PyPI](https://img.shields.io/pypi/v/wkhtmltopdf-api) ![PyPI](https://img.shields.io/pypi/pyversions/wkhtmltopdf-api)\n\n\nIn short, the script acts as a wrapper for Wkhtmltopdf. It replaces the local binary and transfers the job of generating pdf files to an external api.\n\n\n\n## Installation\n\nInstall from PyPI:\n```bash\npip install wkhtmltopdf-api\n```\n\n## Configuration\n\n### Environment vars\n\n  - REPORT_API_URL: str, required\n\n\n  - REPORT_API_TIMEOUT: seconds, default 300\n  - REPORT_API_SIZE_LIMIT: bytes, default 100000000 (100mb)\n  - WKHTMLTOPDF_VERSION: str, default 0.12.6\n\n\n### Usage\n\n\n\nSame as wkhtmltopdf, see options : https://wkhtmltopdf.org/usage/wkhtmltopdf.txt\n\n```bash\nwkhtmltopdf-api --disable-local-file-access --cookie session_id abcd --quiet --page-size A4 --margin-top 40.0 --dpi 90 --zoom 1.0666666666666667 --header-spacing 35 --margin-left 7.0 --margin-bottom 28.0 --margin-right 7.0 --orientation Portrait --header-html /tmp/report.header.tmp.xxx.html --footer-html /tmp/report.footer.tmp.xxx.html /tmp/report.body.tmp.xxx.html /tmp/report.tmp.xxx.pdf\n\n```\n",
    "bugtrack_url": null,
    "license": "BSD 2-clause",
    "summary": "Wkhtmltopdf API Wrapper",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/royaurelien/wkhtmltopdf-api"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c6d6ae947249d3704042cef50d392cebe0e322f6a1d18bace023c3ea405eb05e",
                "md5": "4b7e297af2a33843855494f621472e8f",
                "sha256": "1819b229ed227990f6ac8efdaf9860d8581900992b1cd6c02b016694b4739249"
            },
            "downloads": -1,
            "filename": "wkhtmltopdf_api-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4b7e297af2a33843855494f621472e8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4398,
            "upload_time": "2024-08-21T18:06:41",
            "upload_time_iso_8601": "2024-08-21T18:06:41.869708Z",
            "url": "https://files.pythonhosted.org/packages/c6/d6/ae947249d3704042cef50d392cebe0e322f6a1d18bace023c3ea405eb05e/wkhtmltopdf_api-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7c82d08c5e2163b14e5bfe4b719cc7694a701c67191b8ad3801fd6ccc716bfb4",
                "md5": "3d61f920a569c413dc93647001063b1d",
                "sha256": "c4e90b892292af0cc5e2c963cfe5306950d0328b91281dc8220f228fc6e879ef"
            },
            "downloads": -1,
            "filename": "wkhtmltopdf_api-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "3d61f920a569c413dc93647001063b1d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5474,
            "upload_time": "2024-08-21T18:06:42",
            "upload_time_iso_8601": "2024-08-21T18:06:42.804290Z",
            "url": "https://files.pythonhosted.org/packages/7c/82/d08c5e2163b14e5bfe4b719cc7694a701c67191b8ad3801fd6ccc716bfb4/wkhtmltopdf_api-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-21 18:06:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "royaurelien",
    "github_project": "wkhtmltopdf-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        }
    ],
    "lcname": "wkhtmltopdf-api"
}
        
Elapsed time: 0.29910s