jupyter-book


Namejupyter-book JSON
Version 1.0.0 PyPI version JSON
download
home_pageNone
SummaryBuild a book with Jupyter Notebooks and Sphinx.
upload_time2024-01-26 14:30:40
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords reproducible science environments scholarship notebook
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

Jupyter Book is still developing relatively rapidly, so please be patient if things change
or features iterate and change quickly. Once Jupyter Book hits 1.0, it will slow down
considerably!

## 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": "reproducible,science,environments,scholarship,notebook",
    "author": null,
    "author_email": "Executable Book Project <executablebooks@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d0/3a/bc9fd26be1672f167d2efddbf4fef82b2d52c9641786f392a84314960d6a/jupyter_book-1.0.0.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\n\nJupyter Book is still developing relatively rapidly, so please be patient if things change\nor features iterate and change quickly. Once Jupyter Book hits 1.0, it will slow down\nconsiderably!\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": null,
    "summary": "Build a book with Jupyter Notebooks and Sphinx.",
    "version": "1.0.0",
    "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": [
        "reproducible",
        "science",
        "environments",
        "scholarship",
        "notebook"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "cf0f7ee90f91e1a4f2e72376ad481d5f97b877b9fee4a5bf1a71deaf08a10c77",
                "md5": "b6edcb78dcf844509c7de1083df35b85",
                "sha256": "18238f1e7e1d425731e60ab509a7da878dd6db88b7d77bcfab4690361b72e1be"
            },
            "downloads": -1,
            "filename": "jupyter_book-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b6edcb78dcf844509c7de1083df35b85",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 43723,
            "upload_time": "2024-01-26T14:30:38",
            "upload_time_iso_8601": "2024-01-26T14:30:38.646417Z",
            "url": "https://files.pythonhosted.org/packages/cf/0f/7ee90f91e1a4f2e72376ad481d5f97b877b9fee4a5bf1a71deaf08a10c77/jupyter_book-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d03abc9fd26be1672f167d2efddbf4fef82b2d52c9641786f392a84314960d6a",
                "md5": "38690bbc849009d10b2d833489d88b49",
                "sha256": "539c5d0493546200d9de27bd4b5f77eaea03115f8937f825d4ff82b3801a987e"
            },
            "downloads": -1,
            "filename": "jupyter_book-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "38690bbc849009d10b2d833489d88b49",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 63540,
            "upload_time": "2024-01-26T14:30:40",
            "upload_time_iso_8601": "2024-01-26T14:30:40.907475Z",
            "url": "https://files.pythonhosted.org/packages/d0/3a/bc9fd26be1672f167d2efddbf4fef82b2d52c9641786f392a84314960d6a/jupyter_book-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-26 14:30:40",
    "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.16782s