jupyter-book


Namejupyter-book JSON
Version 1.0.4.post1 PyPI version JSON
download
home_pageNone
SummaryNone
upload_time2025-02-28 14:55:48
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseBSD 3-Clause License Copyright (c) 2021, Executable Book Project All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
keywords environments notebook reproducible scholarship science
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # <img src="https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/images/logo-square.svg" width=40 /> Jupyter Book

[![Jupyter Book Badge](docs/images/badge.svg)](https://jupyterbook.org)
[![CircleCI](https://circleci.com/gh/executablebooks/jupyter-book.svg?style=svg)](https://circleci.com/gh/executablebooks/jupyter-book)
[![codecov](https://codecov.io/gh/executablebooks/jupyter-book/branch/master/graph/badge.svg)](https://codecov.io/gh/executablebooks/jupyter-book)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2561065.svg)](https://doi.org/10.5281/zenodo.2561065)
[![PyPI][pypi-badge]][pypi-link]
[![Conda][conda-badge]][conda-link]

Jupyter Book is an open-source tool for building publication-quality books and documents from computational material.

Jupyter Book allows users to

* write their content in [markdown files](https://myst-parser.readthedocs.io/en/latest/) or [Jupyter](https://jupyter.org/) notebooks,
* include computational elements (e.g., code cells) in either type,
* include rich syntax such as citations, cross-references, and numbered equations, and
* using a simple command, run the embedded code cells, [cache](https://jupyter-cache.readthedocs.io/en/latest/) the outputs and convert this content into:
  * a web-based interactive book and
  * a publication-quality PDF.

## Governance of this project and Jupyter Book 2.x

Jupyter Book 1.x is now in a maintenance phase, where new feature requests have lower priority than bugfixes.

Jupyter Book 2.x will be built on the new [MyST-MD document engine](https://mystmd.org/). See [this blog post](https://executablebooks.org/en/latest/blog/2024-05-20-jupyter-book-myst/) for more information on our plans, and [this blog post](https://blog.jupyterbook.org/posts/2024-11-15-jupyter-book-2-alpha) about the alpha release of Jupyter Book 2.x.

Jupyter Book 2.x is currently being developed on the `next` branch, and documentation for Jupyter Book 2.x can be found at [next.jupyterbook.org](https://next.jupyterbook.org).

## Contribute or improve the book

Notice some inefficient CSS? A typo in the text? Want to add a cool feature so that others
can enjoy the improvements to Jupyter Books? Check out the [Jupyter Book Contributor's
Guide](https://jupyterbook.org/contribute/intro.html). We'd love your help!

## Acknowledgements

Jupyter Book is maintained and primarily developed by
the [Executable Book Project](https://executablebooks.org).

[pypi-badge]: https://img.shields.io/pypi/v/jupyter-book.svg
[pypi-link]: https://pypi.org/project/jupyter-book
[conda-badge]: https://anaconda.org/conda-forge/jupyter-book/badges/version.svg
[conda-link]: https://anaconda.org/conda-forge/jupyter-book

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "jupyter-book",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "environments, notebook, reproducible, scholarship, science",
    "author": null,
    "author_email": "Executable Book Project <executablebooks@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/cf/ee/5d10ce5b161764ad44219853f386e98b535cb3879bcb0d7376961a1e3897/jupyter_book-1.0.4.post1.tar.gz",
    "platform": null,
    "description": "# <img src=\"https://raw.githubusercontent.com/executablebooks/jupyter-book/master/docs/images/logo-square.svg\" width=40 /> Jupyter Book\n\n[![Jupyter Book Badge](docs/images/badge.svg)](https://jupyterbook.org)\n[![CircleCI](https://circleci.com/gh/executablebooks/jupyter-book.svg?style=svg)](https://circleci.com/gh/executablebooks/jupyter-book)\n[![codecov](https://codecov.io/gh/executablebooks/jupyter-book/branch/master/graph/badge.svg)](https://codecov.io/gh/executablebooks/jupyter-book)\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.2561065.svg)](https://doi.org/10.5281/zenodo.2561065)\n[![PyPI][pypi-badge]][pypi-link]\n[![Conda][conda-badge]][conda-link]\n\nJupyter Book is an open-source tool for building publication-quality books and documents from computational material.\n\nJupyter Book allows users to\n\n* write their content in [markdown files](https://myst-parser.readthedocs.io/en/latest/) or [Jupyter](https://jupyter.org/) notebooks,\n* include computational elements (e.g., code cells) in either type,\n* include rich syntax such as citations, cross-references, and numbered equations, and\n* using a simple command, run the embedded code cells, [cache](https://jupyter-cache.readthedocs.io/en/latest/) the outputs and convert this content into:\n  * a web-based interactive book and\n  * a publication-quality PDF.\n\n## Governance of this project and Jupyter Book 2.x\n\nJupyter Book 1.x is now in a maintenance phase, where new feature requests have lower priority than bugfixes.\n\nJupyter Book 2.x will be built on the new [MyST-MD document engine](https://mystmd.org/). See [this blog post](https://executablebooks.org/en/latest/blog/2024-05-20-jupyter-book-myst/) for more information on our plans, and [this blog post](https://blog.jupyterbook.org/posts/2024-11-15-jupyter-book-2-alpha) about the alpha release of Jupyter Book 2.x.\n\nJupyter Book 2.x is currently being developed on the `next` branch, and documentation for Jupyter Book 2.x can be found at [next.jupyterbook.org](https://next.jupyterbook.org).\n\n## Contribute or improve the book\n\nNotice some inefficient CSS? A typo in the text? Want to add a cool feature so that others\ncan enjoy the improvements to Jupyter Books? Check out the [Jupyter Book Contributor's\nGuide](https://jupyterbook.org/contribute/intro.html). We'd love your help!\n\n## Acknowledgements\n\nJupyter Book is maintained and primarily developed by\nthe [Executable Book Project](https://executablebooks.org).\n\n[pypi-badge]: https://img.shields.io/pypi/v/jupyter-book.svg\n[pypi-link]: https://pypi.org/project/jupyter-book\n[conda-badge]: https://anaconda.org/conda-forge/jupyter-book/badges/version.svg\n[conda-link]: https://anaconda.org/conda-forge/jupyter-book\n",
    "bugtrack_url": null,
    "license": "BSD 3-Clause License\n        \n        Copyright (c) 2021, Executable Book Project\n        All rights reserved.\n        \n        Redistribution and use in source and binary forms, with or without\n        modification, are permitted provided that the following conditions are met:\n        \n        * Redistributions of source code must retain the above copyright notice, this\n          list of conditions and the following disclaimer.\n        \n        * Redistributions in binary form must reproduce the above copyright notice,\n          this list of conditions and the following disclaimer in the documentation\n          and/or other materials provided with the distribution.\n        \n        * Neither the name of the copyright holder nor the names of its\n          contributors may be used to endorse or promote products derived from\n          this software without specific prior written permission.\n        \n        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\n        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\n        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\n        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\n        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\n        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\n        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\n        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\n        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
    "summary": null,
    "version": "1.0.4.post1",
    "project_urls": {
        "Documentation": "https://jupyterbook.org",
        "Funding": "https://executablebooks.org",
        "Homepage": "https://executablebooks.org/",
        "Source": "https://github.com/executablebooks/jupyter-book/",
        "Tracker": "https://github.com/executablebooks/jupyter-book/issues"
    },
    "split_keywords": [
        "environments",
        " notebook",
        " reproducible",
        " scholarship",
        " science"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3786d45756beaeb4b9b06125599b429451f8640b5db6f019d606f33c85743fd4",
                "md5": "5f017f2b166a9b58f3bd706f7b0cfe49",
                "sha256": "3a27a6b2581f1894ffe8f347d1a3432f06fc616997547919c42cd41c54db625d"
            },
            "downloads": -1,
            "filename": "jupyter_book-1.0.4.post1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5f017f2b166a9b58f3bd706f7b0cfe49",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 45005,
            "upload_time": "2025-02-28T14:55:46",
            "upload_time_iso_8601": "2025-02-28T14:55:46.561275Z",
            "url": "https://files.pythonhosted.org/packages/37/86/d45756beaeb4b9b06125599b429451f8640b5db6f019d606f33c85743fd4/jupyter_book-1.0.4.post1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cfee5d10ce5b161764ad44219853f386e98b535cb3879bcb0d7376961a1e3897",
                "md5": "a29feee2a6679d787c657536ec2d612f",
                "sha256": "2fe92c49ff74840edc0a86bb034eafdd0f645fca6e48266be367ce4d808b9601"
            },
            "downloads": -1,
            "filename": "jupyter_book-1.0.4.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "a29feee2a6679d787c657536ec2d612f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 67412,
            "upload_time": "2025-02-28T14:55:48",
            "upload_time_iso_8601": "2025-02-28T14:55:48.637062Z",
            "url": "https://files.pythonhosted.org/packages/cf/ee/5d10ce5b161764ad44219853f386e98b535cb3879bcb0d7376961a1e3897/jupyter_book-1.0.4.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-28 14:55:48",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "executablebooks",
    "github_project": "jupyter-book",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "jupyter-book"
}
        
Elapsed time: 0.74971s