{ "info": { "author": "Charles TISSIER", "author_email": "charles@vingtcinq.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Django :: 1.10", "Framework :: Django :: 1.9", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.3", "Programming Language :: Python :: 2.4", "Programming Language :: Python :: 2.5", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "|nightmare-pdf v0.1.10 on PyPi| |MIT license| |Stable|\n\ndjango-nightmare-pdf\n====================\n\nConvert HTML to pdf with django using nightmare\n\nRequirements\n------------\n\n- Python (2.7) (Need to be tested for 3.x)\n- Django (1.10, 1.9) (Need to be tested for previous versions)\n\nDependencies\n------------\n\nThis django app depends on\n`Nightmare `__, you need to\nfirst install it using ``npm``:\n\n``npm install nightmare``\n\nInstallation\n------------\n\nInstall using ``pip`` :\n\n``pip install nightmare_pdf``\n\nAdd ``nightmare_pdf`` to your INSTALLED\\_APPS setting.\n\n::\n\n INSTALLED_APPS = (\n ...\n 'nightmare_pdf',\n )\n\ncreate a directory to hold pdf files created by Nightmare, default to\n``pdf_temp`` :\n\n``mkdir pdf_temp``\n\nExample\n-------\n\nGenerate a pdf from an url and save it to database, or retrieve it as a\nContentFile, or return it inside an HttpResponse :\n\n::\n\n from nightmare_pdf.generators import PDFGenerator\n\n pdf = PDFGenerator(url=\"https://github.com/charlesthk/django-nightmare-pdf\",\n\n # Save it to database and retrieve a PdfDoc Object (database):\n pdf.save(\n filename='nightmare_pdf',\n title=\"nightmare_pdf on github\",\n description=\"Convert HTML to pdf with django using nightmare\")\n\n # Get the PDf as a Django ContentFile named 'my_pdf_file.pdf' :\n pdf_content_file = pdf.get_content_file('my_pdf_file') \n\n # Return a Django HttpResponse with the PDF Attached named 'my_pdf_file.pdf':\n return pdf.get_http_response('my_pdf_file')\n\n``PDFGenerator`` options\n------------------------\n\nThe ``PDFGenerator`` class accepts the following arguments :\n\n- url [required]\n- timeout [Optional] default to 1000, defines the timeout between the\n opening and the rendering of the url by nightmare\n- page\\_size [Optional] default to 'A4', accepts options are A3, A4,\n A5, Legal, Letter or Tabloid\n- landscape [Optional] default to 0, defines whether rendering pdf in\n landscape mode\n- print\\_background [Optional] default to 1, defines whether printing\n background\n- margins\\_type [Optional] default to 1, defines which margins to use.\n Uses 0 for default margin, 1 for no margin, and 2 for minimum margin.\n- script [Optional] default to DEFAULT\\_RENDER\\_SCRIPT, defines which\n render script to use.\n- temp\\_dir [Optional] default to DEFAULT\\_TEMP\\_DIR, defines which\n temp dir to use.\n\nModel use for saving PDF\n------------------------\n\nWhen using ``save(filename, title='', description='')`` method of\n``PDFGenerator``, the following model is used:\n\n::\n\n class PdfDoc(models.Model):\n \"\"\"\n Store each generated pdf\n \"\"\"\n title = models.CharField(verbose_name=_(\"Title\"), max_length=255, blank=True)\n description = models.TextField(verbose_name=_(\"Description\"), blank=True)\n document = models.FileField(verbose_name=_(\"Document PDF\"), upload_to=pdf_settings.UPLOAD_TO)\n created_at = models.DateTimeField(auto_now=False, auto_now_add=True, verbose_name=_('Creation'))\n updated_at = models.DateTimeField(auto_now=True, auto_now_add=False, verbose_name=_('Update'))\n\nSettings\n--------\n\nAdd your settings to your main django settings file. The settings are\nset by default to :\n\n::\n\n NIGHTMARE_PDF = {\n 'UPLOAD_TO': 'pdfs',\n 'NODE_PATH': 'node',\n 'DEFAULT_RENDER_SCRIPT': os.path.join(NIGHTMARE_PDF_DIR, 'render_pdf.js'),\n 'DEFAULT_TEMP_DIR': os.path.join(settings.BASE_DIR, 'pdf_temp')\n }\n\n``UPLOAD_TO``\n~~~~~~~~~~~~~\n\nDefine the directory or the function to be used when saving PDFs,\ndefault to ``pdfs``.\n\n``NODE_PATH``\n~~~~~~~~~~~~~\n\nDefine the path to Node binary, default to ``node``.\n\n``DEFAULT_RENDER_SCRIPT``\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nDefine which render\\_script to use by default, default to\n``render_pdf.js`` inside the package.\n\n``DEFAULT_TEMP_DIR``\n~~~~~~~~~~~~~~~~~~~~\n\nDefine the directory to use for temporarily generated pdf by Nightmare.\ndefault to ``pdf_temp``.\n\nSupport\n-------\n\nIf you are having issues, please let us know or submit a pull request.\n\nLicense\n-------\n\nThe project is licensed under the MIT License.\n\n.. |nightmare-pdf v0.1.10 on PyPi| image:: https://img.shields.io/badge/pypi-0.1.10-green.svg\n :target: https://pypi.python.org/pypi/nightmare-pdf\n.. |MIT license| image:: https://img.shields.io/badge/licence-MIT-blue.svg\n.. |Stable| image:: https://img.shields.io/badge/status-stable-green.svg", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/charlesthk/django-nightmare-pdf", "keywords": "python django pdf html nightmare", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "nightmare_pdf", "package_url": "https://pypi.org/project/nightmare_pdf/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/nightmare_pdf/", "project_urls": { "Homepage": "https://github.com/charlesthk/django-nightmare-pdf" }, "release_url": "https://pypi.org/project/nightmare_pdf/0.1.0/", "requires_dist": null, "requires_python": "", "summary": "Convert HTML to pdf with django using nightmarejs", "version": "0.1.0" }, "last_serial": 2579063, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "c7f3c30267abdc48f2000cffc0531999", "sha256": "97a599e9a5664152b10dbdc36864a947252a5d08f8fcb36f978ce05f94fb34bf" }, "downloads": -1, "filename": "nightmare_pdf-0.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "c7f3c30267abdc48f2000cffc0531999", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8904, "upload_time": "2017-01-16T17:30:49", "url": "https://files.pythonhosted.org/packages/d7/c7/a7790508f8c7b354b98ab54e25eaf5df8d720f3a26c6dc26748c27f6801f/nightmare_pdf-0.0.1-py2.py3-none-any.whl" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "e2454d2cce34ef0971ee11bd400d3f28", "sha256": "298f567e99e4e8d28afb23757ce699119d047a025d37aa6aac60a801b969a475" }, "downloads": -1, "filename": "nightmare_pdf-0.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e2454d2cce34ef0971ee11bd400d3f28", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8894, "upload_time": "2017-01-16T17:37:45", "url": "https://files.pythonhosted.org/packages/c2/4b/f545d8ca7688b903a72ea5a69a5a00a3a11d85f50c069cebf572bac68ad6/nightmare_pdf-0.0.2-py2.py3-none-any.whl" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "4855f67e55f19db172cdd260005e72dd", "sha256": "81162cc406b2b28dae2970f76000925b39f0dd5ecfe098c0151b7677f77ec7ca" }, "downloads": -1, "filename": "nightmare_pdf-0.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4855f67e55f19db172cdd260005e72dd", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8894, "upload_time": "2017-01-16T17:58:18", "url": "https://files.pythonhosted.org/packages/d0/8b/ebccdb130cd90990c905942a95b17874de7ff15b2472605d61df4017b887/nightmare_pdf-0.0.3-py2.py3-none-any.whl" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "cc3b829fd3b57a344f559a00c6021ad4", "sha256": "f29099f27cec3d94b104c3d45bb4f99a2df0add52d58aee0e30b85e7ed7fd34b" }, "downloads": -1, "filename": "nightmare_pdf-0.0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cc3b829fd3b57a344f559a00c6021ad4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8866, "upload_time": "2017-01-16T18:11:06", "url": "https://files.pythonhosted.org/packages/74/ec/b1679229ee35fe36128c29a2970257b1b0b4fb70bb1baf6dff7e7b492d84/nightmare_pdf-0.0.4-py2.py3-none-any.whl" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "53649183163b5f601023e58701007fb1", "sha256": "b62d6f187afbabdb04a5e9aaa95d0aca24dcea7af78d21b5e0811810e2307245" }, "downloads": -1, "filename": "nightmare_pdf-0.0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "53649183163b5f601023e58701007fb1", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8894, "upload_time": "2017-01-16T18:29:33", "url": "https://files.pythonhosted.org/packages/f4/6d/1f159c2fe4ca372a89bd6a3c1b1ab40607d2deddf25cbc7466cb385fc13b/nightmare_pdf-0.0.5-py2.py3-none-any.whl" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "efa3251e5de0e43d41d734ac4ddceeee", "sha256": "5c4857fb1bd7819e429b34e033d1de005b0b462d41f5ce5dff6d6108865adf01" }, "downloads": -1, "filename": "nightmare_pdf-0.0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "efa3251e5de0e43d41d734ac4ddceeee", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8216, "upload_time": "2017-01-16T18:42:03", "url": "https://files.pythonhosted.org/packages/13/8a/396b871b58fbd8337128975c94d333b343ac35fd0ff009d9dcf97b50a86b/nightmare_pdf-0.0.6-py2.py3-none-any.whl" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "d52e13cfb7caf5395efaf02684a7a6ad", "sha256": "f9f03637dee3b2b874373e348a8bfb05e88fb217a4e57a5018b86d39c717f9bc" }, "downloads": -1, "filename": "nightmare_pdf-0.0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d52e13cfb7caf5395efaf02684a7a6ad", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8212, "upload_time": "2017-01-16T18:55:49", "url": "https://files.pythonhosted.org/packages/6b/22/4f19c637416274774419a7ed9b2b11f3dedfd7b1373de540f1f1cae760e1/nightmare_pdf-0.0.7-py2.py3-none-any.whl" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "cd7bb6bf1c1398c13051e5eb24a2ea4f", "sha256": "7b9b13eaa8d5a6108ff0a609579f41eb11add599895a00d5e3abbe3a65af0e8a" }, "downloads": -1, "filename": "nightmare_pdf-0.0.8-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cd7bb6bf1c1398c13051e5eb24a2ea4f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9628, "upload_time": "2017-01-16T19:00:37", "url": "https://files.pythonhosted.org/packages/a8/49/535ca24fce6a93ac19751bb3642a5b894322e768aa6d1df031e6808291ad/nightmare_pdf-0.0.8-py2.py3-none-any.whl" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "1e0f955a72ca91beeba6d948f82d5b2a", "sha256": "c304238bc42c7ffcd64dba86253cd8c4c8dae72925f5b96766a8fae5144e6b09" }, "downloads": -1, "filename": "nightmare_pdf-0.0.9-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1e0f955a72ca91beeba6d948f82d5b2a", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11492, "upload_time": "2017-01-16T19:30:57", "url": "https://files.pythonhosted.org/packages/ec/b4/6e5f5a8e3a45a630bcec00e32b6151baa886bf4279753fff16dc7560f4c7/nightmare_pdf-0.0.9-py2.py3-none-any.whl" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "1727eefc4be1761e5c7893a1d4bab90d", "sha256": "cbd7847f065dce5ab3fc56fbc0b9df7a2eada51866c129780ab5636ed247e7b2" }, "downloads": -1, "filename": "nightmare_pdf-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1727eefc4be1761e5c7893a1d4bab90d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11587, "upload_time": "2017-01-17T08:26:24", "url": "https://files.pythonhosted.org/packages/af/83/979ab0df19013cedf8e166a681fbb01068fe3baed764f5c4907a92dab6cc/nightmare_pdf-0.1.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1727eefc4be1761e5c7893a1d4bab90d", "sha256": "cbd7847f065dce5ab3fc56fbc0b9df7a2eada51866c129780ab5636ed247e7b2" }, "downloads": -1, "filename": "nightmare_pdf-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "1727eefc4be1761e5c7893a1d4bab90d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11587, "upload_time": "2017-01-17T08:26:24", "url": "https://files.pythonhosted.org/packages/af/83/979ab0df19013cedf8e166a681fbb01068fe3baed764f5c4907a92dab6cc/nightmare_pdf-0.1.0-py2.py3-none-any.whl" } ] }