{
    "info": {
        "author": "Gregor Sturm",
        "author_email": "mail@gregor-sturm.de",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Intended Audience :: Developers",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 3",
            "Programming Language :: R"
        ],
        "description": "Generate reproducible reports from Rmarkdown or jupyter notebooks\n=================================================================\n|travis| |docs| |black|\n\n.. |travis| image:: https://travis-ci.com/grst/reportsrender.svg?branch=master\n    :target: https://travis-ci.com/grst/reportsrender\n    :alt: Build Status\n\n.. |docs| image:: https://readthedocs.org/projects/reportsrender/badge/?version=latest\n    :target: https://reportsrender.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n    \n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: The uncompromising python formatter\n\nReportsrender allows to create reproducible, consistently looking HTML reports from\nboth jupyter notebooks and Rmarkdown files. It makes use of `papermill <https://github.com/nteract/papermill>`_\nand `Rmarkdown <https://bookdown.org/yihui/rmarkdown/>`_ to execute notebooks and uses\n`Pandoc <https://pandoc.org/>`_ to convert them to HTML.\n\n**Features**:\n * two execution engines: papermill and Rmarkdown.\n * support any format supported by `jupytext <https://github.com/mwouts/jupytext>`_.\n * create self-contained HTML that can be shared easily.\n * hide inputs and/or outputs of cells.\n * parametrized reports\n\nSee the `documentation <https://reportsrender.readthedocs.io/>`_ for more details!\n\nGetting started\n================\n\n* Execute an rmarkdown document to HTML using the Rmarkdown engine\n\n::\n\n    reportsrender --engine=rmd my_notebook.Rmd report.html\n\n* Execute a parametrized jupyter notebook with papermill\n\n::\n\n    reportsrender --engine=papermill jupyter_notebook.ipynb report.html --params=\"data_file=table.tsv\"\n\n\n.. _cli:\n\nUsage from command line\n=======================\n\n::\n\n    reportsrender\n\n    Execute and render a jupyter/Rmarkdown notebook.\n    The `index` subcommand generates an index html\n    or markdown file that links to html documents.\n\n    Usage:\n      reportsrender <notebook> <out_file> [--cpus=<cpus>] [--params=<params>] [--engine=<engine>]\n      reportsrender index [--index=<index_file>] [--title=<title>] [--] <html_files>...\n      reportsrender --help\n\n    Arguments and options:\n      <notebook>            Input notebook to be executed. Can be any format supported by jupytext.\n      <out_file>            Output HTML file.\n      -h --help             Show this screen.\n      --cpus=<cpus>         Number of CPUs to use for Numba/Numpy/OpenBLAS/MKL [default: 1]\n      --params=<params>     space-separated list of key-value pairs that will be passed\n                            to papermill/Rmarkdown.\n                            E.g. \"input_file=dir/foo.txt output_file=dir2/bar.html\"\n      --engine=<engine>     Engine to execute the notebook. [default: auto]\n\n    Arguments and options of the `index` subcommand:\n      <html_files>          List of HTML files that will be included in the index. The tool\n                            will generate relative links from the index file to these files.\n      --index=<index_file>  Path to the index file that will be generated. Will be\n                            overwritten if exists. Will auto-detect markdown (.md) and\n                            HTML (.html) format based on the extension. [default: index.html]\n      --title=<title>       Headline of the index. [default: Index]\n\n    Possible engines are:\n      auto                  Use `rmd` engine for `*.Rmd` files, papermill otherwise.\n      rmd                   Use `rmarkdown` to execute the notebook. Supports R and\n                            python (through reticulate)\n      papermill             Use `papermill` to execute the notebook. Works for every\n                            kernel available in the jupyter installation.\n\n\n\n\n\n\nInstallation\n============\n\nConda (recommended):\n^^^^^^^^^^^^^^^^^^^^\nAs this reportsrender dependes on both R and Python packages, I recommend\nto install it through `conda <https://docs.conda.io/en/latest/miniconda.html>`_.\nThe following command will install reportsrender and all its dependencies in the \ncurrent conda environment: \n\n::\n\n    conda install -c conda-forge grst::reportsrender\n\nIf you prefer not to use conda, you can follow the approach below: \n\n\nManual installation:\n^^^^^^^^^^^^^^^^^^^^\n\nGet dependencies:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n* Python\n* `pandoc`_\n\nFor the Rmarkdown render engine additionally\n(there is no need to install them if you are not going\nto use the Rmarkdown rendeirng engine):\n\n* R and the following packages:\n\n::\n\n    rmarkdown\n    reticulate\n\nthen, \n\n\nInstall from  pip:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n::\n\n    pip install reportsrender\n\nor, \n\nInstall from github:\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\n::\n\n    pip install flit\n    flit installfrom github:grst/reportsrender\n\n\n\n",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/grst/reportsrender",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "reportsrender",
        "package_url": "https://pypi.org/project/reportsrender/",
        "platform": "",
        "project_url": "https://pypi.org/project/reportsrender/",
        "project_urls": {
            "Homepage": "https://github.com/grst/reportsrender"
        },
        "release_url": "https://pypi.org/project/reportsrender/0.3.2/",
        "requires_dist": [
            "docopt",
            "ipython",
            "jupytext>=1.3.0",
            "papermill",
            "nbconvert",
            "ipykernel",
            "get_version",
            "lxml",
            "sphinx>=2 ; extra == \"doc\"",
            "sphinx_autodoc_typehints>=1.8.0 ; extra == \"doc\"",
            "sphinx_rtd_theme>=0.4 ; extra == \"doc\"",
            "pytest ; extra == \"test\"",
            "matplotlib ; extra == \"test\""
        ],
        "requires_python": ">= 3.6",
        "summary": "Execute and render notebooks as HTML reports. ",
        "version": "0.3.2",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 6292078,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d80d9d9513401eeb4cf735fc54ebfc07",
                    "sha256": "e194bfa3a1a8826912f14d4530bdb6f67c3bf7d5a2090a4e5d96f167caab091d"
                },
                "downloads": -1,
                "filename": "reportsrender-0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d80d9d9513401eeb4cf735fc54ebfc07",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 359392,
                "upload_time": "2019-10-31T10:33:59",
                "upload_time_iso_8601": "2019-10-31T10:33:59.257257Z",
                "url": "https://files.pythonhosted.org/packages/9c/c7/aa2da4591f9381c4f63cb26b0e22922379269afbbaadf8a1a0ec60e6d691/reportsrender-0.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "260d46f3225cd2666356d18dc95b4749",
                    "sha256": "cbc4e1f72de5dc6c2a737bd6256405c93579f2bc96dc74392fbd870e21dcc1d8"
                },
                "downloads": -1,
                "filename": "reportsrender-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "260d46f3225cd2666356d18dc95b4749",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 102650,
                "upload_time": "2019-10-31T10:34:02",
                "upload_time_iso_8601": "2019-10-31T10:34:02.963280Z",
                "url": "https://files.pythonhosted.org/packages/f5/54/a932ad4b0abf300f241122261cdbbf49f9c91611d48d68ac5e1723e5d51a/reportsrender-0.1.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad350f09036216cdc64f18706de2e539",
                    "sha256": "6342d66319c7db9bd6254710c87800bd183318a110aa863e18d69451b010ce21"
                },
                "downloads": -1,
                "filename": "reportsrender-0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "ad350f09036216cdc64f18706de2e539",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 360939,
                "upload_time": "2019-11-04T08:56:32",
                "upload_time_iso_8601": "2019-11-04T08:56:32.250596Z",
                "url": "https://files.pythonhosted.org/packages/ba/8f/127af900b6befdab892a89f781eb20b59155fc367c20e343d258d6a048a2/reportsrender-0.2-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c5e64a8f477b48696183614c04731be",
                    "sha256": "b6f9c712f8d8bd650adaa2ac130c442d6fcfccb0a0df301d19b06331824dd366"
                },
                "downloads": -1,
                "filename": "reportsrender-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "6c5e64a8f477b48696183614c04731be",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 103319,
                "upload_time": "2019-11-04T08:56:34",
                "upload_time_iso_8601": "2019-11-04T08:56:34.967757Z",
                "url": "https://files.pythonhosted.org/packages/21/bc/f10b721c8ddbfb4937a1cbae282ef6afc4b473c10df014fd65f2cd2caa3f/reportsrender-0.2.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0bfc8b49010530b6cf06d29558a0d3f8",
                    "sha256": "c3a47524f7237c6154064ca1cc39a79cc61a9098dc51354daf0f69c78b8cdc9c"
                },
                "downloads": -1,
                "filename": "reportsrender-0.2.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0bfc8b49010530b6cf06d29558a0d3f8",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 361386,
                "upload_time": "2019-11-07T18:31:23",
                "upload_time_iso_8601": "2019-11-07T18:31:23.897805Z",
                "url": "https://files.pythonhosted.org/packages/67/cf/5e2dcfc0a12f47130c79146f13c62bed90503bc9e97897391a8aa4c651ba/reportsrender-0.2.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "4cdaca89bf47a7cab02ab67a922ddbdb",
                    "sha256": "7b50c10e56a4df4e890221b8af40daed0a1a4e00f3b5e554c78977742c9c8681"
                },
                "downloads": -1,
                "filename": "reportsrender-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "4cdaca89bf47a7cab02ab67a922ddbdb",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 169588,
                "upload_time": "2019-11-07T18:31:26",
                "upload_time_iso_8601": "2019-11-07T18:31:26.731641Z",
                "url": "https://files.pythonhosted.org/packages/11/4e/6b34df5c85723d97103d5600aea9c1b5877cd81c4a379ec583830ce39cb1/reportsrender-0.2.1.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "16ba85065646b7cc294edfac754833a8",
                    "sha256": "2bcfddba409161351f1c1e07b3d568c38732c51033b2bf2b15e8fb34d2b17731"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "16ba85065646b7cc294edfac754833a8",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 365054,
                "upload_time": "2019-11-20T17:20:38",
                "upload_time_iso_8601": "2019-11-20T17:20:38.038001Z",
                "url": "https://files.pythonhosted.org/packages/32/5e/ec7f8978fa5637b9f3c32e9cdfae9ccbd93f5706138234ef88e7bb3c588f/reportsrender-0.3.0-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "13b7153d8644b914887c156f01c67434",
                    "sha256": "77f9fb7f0258415138f344fcfa393fe29a9f40db3617c073bcf429a27e899de5"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.0.tar.gz",
                "has_sig": false,
                "md5_digest": "13b7153d8644b914887c156f01c67434",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 818025,
                "upload_time": "2019-11-20T17:20:41",
                "upload_time_iso_8601": "2019-11-20T17:20:41.238834Z",
                "url": "https://files.pythonhosted.org/packages/6e/b3/0da7a0663397a91224d2f8e423278716432cd4a17e2005d6330215fc5329/reportsrender-0.3.0.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "73736ce813755b6ab9ff43ddcd012a5c",
                    "sha256": "b5c205bdd5092f1fb40a11736f4dcf64768b9fcf74f6e66c2a4a6db4266c59f1"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "73736ce813755b6ab9ff43ddcd012a5c",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 117597,
                "upload_time": "2019-12-02T08:48:59",
                "upload_time_iso_8601": "2019-12-02T08:48:59.636876Z",
                "url": "https://files.pythonhosted.org/packages/c1/90/f90c55df25d3fc3674fe7cc1647631158827af31665a013510184a6f2307/reportsrender-0.3.1-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "59702159d09956719df2a31a4a02a2e8",
                    "sha256": "09bd0ff6859a19718675cb4ebf05e5fd4ce418010ab51e17147c154588a67e9e"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "59702159d09956719df2a31a4a02a2e8",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 817994,
                "upload_time": "2019-12-02T08:49:02",
                "upload_time_iso_8601": "2019-12-02T08:49:02.347359Z",
                "url": "https://files.pythonhosted.org/packages/12/56/08203cda71e66cf05bb990eb82d551364f38cd85b1cf119ed62ba4fdb483/reportsrender-0.3.1.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.3.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c38d5503ee290db08815cafcb555bd33",
                    "sha256": "9c6dc2f6a67fb4ea641b5aa3c5c4e8f4d3a7502b12cce392a95a190bd060d7a7"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c38d5503ee290db08815cafcb555bd33",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">= 3.6",
                "size": 117619,
                "upload_time": "2019-12-13T10:27:38",
                "upload_time_iso_8601": "2019-12-13T10:27:38.723336Z",
                "url": "https://files.pythonhosted.org/packages/0c/0c/fe2d7441db31c3ddc44d579c3b9ef139863a80536c51d3f5cecbb09ceba4/reportsrender-0.3.2-py3-none-any.whl",
                "yanked": false,
                "yanked_reason": null
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "400893643d016cc634d345ae362b6091",
                    "sha256": "cb4ab5b7a561805a3a85b6b7d821c68783a1fbdebf9e12b82610b0b8d9beeca6"
                },
                "downloads": -1,
                "filename": "reportsrender-0.3.2.tar.gz",
                "has_sig": false,
                "md5_digest": "400893643d016cc634d345ae362b6091",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">= 3.6",
                "size": 818843,
                "upload_time": "2019-12-13T10:27:43",
                "upload_time_iso_8601": "2019-12-13T10:27:43.856821Z",
                "url": "https://files.pythonhosted.org/packages/01/de/fbb8ef2c07faf38950c790a4811a6f7fec51d6a38a46d3ae84874da5eb6d/reportsrender-0.3.2.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "c38d5503ee290db08815cafcb555bd33",
                "sha256": "9c6dc2f6a67fb4ea641b5aa3c5c4e8f4d3a7502b12cce392a95a190bd060d7a7"
            },
            "downloads": -1,
            "filename": "reportsrender-0.3.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c38d5503ee290db08815cafcb555bd33",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">= 3.6",
            "size": 117619,
            "upload_time": "2019-12-13T10:27:38",
            "upload_time_iso_8601": "2019-12-13T10:27:38.723336Z",
            "url": "https://files.pythonhosted.org/packages/0c/0c/fe2d7441db31c3ddc44d579c3b9ef139863a80536c51d3f5cecbb09ceba4/reportsrender-0.3.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "400893643d016cc634d345ae362b6091",
                "sha256": "cb4ab5b7a561805a3a85b6b7d821c68783a1fbdebf9e12b82610b0b8d9beeca6"
            },
            "downloads": -1,
            "filename": "reportsrender-0.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "400893643d016cc634d345ae362b6091",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">= 3.6",
            "size": 818843,
            "upload_time": "2019-12-13T10:27:43",
            "upload_time_iso_8601": "2019-12-13T10:27:43.856821Z",
            "url": "https://files.pythonhosted.org/packages/01/de/fbb8ef2c07faf38950c790a4811a6f7fec51d6a38a46d3ae84874da5eb6d/reportsrender-0.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}