{ "info": { "author": "Ralf Farkas", "author_email": "r4lv@peaxels.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Framework :: Jupyter", "Intended Audience :: Science/Research", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Topic :: Documentation" ], "description": "\njpy-flette\n==========\n\n*jpy-flette* is a lightweight (~150 lines) python static website generator which uses jupyter notebooks as input. It's fantastic for documenting scientific projects, documentation, or just to share your thoughts with the world.\n\nInstallation\n------------\n\nInstall *jpy-flette* with pip:\n\n.. code:: bash\n\n pip install jpy-flette\n\n\nYou could also download or clone the source code from the `repository `_, then run\n\n.. code:: bash\n\n python setup.py install\n\n\n\n\nUsage\n-----\n\n Make sure you check the `documentation `_, which is actually built using *jpy-flette* itself!\n\n*jpy-flette* transforms a directory full of ``.ipynb`` jupyter notebooks into a website with multiple pages. Let's assume the following directory structure:\n\n.. code:: text\n\n ~/my/directory\n \u2514\u2500\u2500 notebooks\n \u251c\u2500\u2500 00.index.ipynb\n \u2514\u2500\u2500 01.jpy-flette-documentation.ipynb\n\nAfter calling\n\n.. code:: bash\n\n jpy-flette ~/my/directory/notebooks\n\nyou would obtain\n\n.. code:: text\n\n ~/my/directory\n \u251c\u2500\u2500 docs\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 index.html\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 jpy-flette-documentation.html\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 static\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 style.css\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 script.js\n \u2514\u2500\u2500 notebooks\n \u251c\u2500\u2500 00.index.ipynb\n \u2514\u2500\u2500 01.jpy-flette-documentation.ipynb\n\n\n``~/my/directory/docs`` is then ready to be published!\n\n*jpy-flette* can be configured using ``fletteconf.yaml`` files for *theming*, titles/footers and more. Refer the `documentation `_ for more.\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/r4lv/jpy-flette", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "jpy-flette", "package_url": "https://pypi.org/project/jpy-flette/", "platform": "", "project_url": "https://pypi.org/project/jpy-flette/", "project_urls": { "Homepage": "https://github.com/r4lv/jpy-flette" }, "release_url": "https://pypi.org/project/jpy-flette/0.1.0/", "requires_dist": [ "nbconvert", "click", "jinja2", "pyquery", "ipython", "pyyaml" ], "requires_python": ">=3.5.0", "summary": "Static site generator for jupyter notebooks", "version": "0.1.0" }, "last_serial": 3767479, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "207d4a980693b7db6c38d3a051b60d36", "sha256": "892d6e3013da968a40f9157fb80984387e68dafbbff5ba87fc1485b0f84728b5" }, "downloads": -1, "filename": "jpy_flette-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "207d4a980693b7db6c38d3a051b60d36", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5.0", "size": 57079, "upload_time": "2018-04-16T01:44:28", "url": "https://files.pythonhosted.org/packages/18/8c/fbab00da136cc4acf91a868bf07d616615d1647ebfd3b4e9b89a0f2ca2d8/jpy_flette-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ed64486fed454a201b0ff440cc5dec2", "sha256": "9e35a75430def90c02d48171c28ad0d23d4bdc365e97edb0ad62dd040da47a0c" }, "downloads": -1, "filename": "jpy_flette-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0ed64486fed454a201b0ff440cc5dec2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5.0", "size": 55329, "upload_time": "2018-04-16T01:44:31", "url": "https://files.pythonhosted.org/packages/d8/c4/996bdb386c8ca71a90aa5697e714228c7dc0113a96ce6e58e58fb15fb77a/jpy_flette-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "207d4a980693b7db6c38d3a051b60d36", "sha256": "892d6e3013da968a40f9157fb80984387e68dafbbff5ba87fc1485b0f84728b5" }, "downloads": -1, "filename": "jpy_flette-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "207d4a980693b7db6c38d3a051b60d36", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5.0", "size": 57079, "upload_time": "2018-04-16T01:44:28", "url": "https://files.pythonhosted.org/packages/18/8c/fbab00da136cc4acf91a868bf07d616615d1647ebfd3b4e9b89a0f2ca2d8/jpy_flette-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0ed64486fed454a201b0ff440cc5dec2", "sha256": "9e35a75430def90c02d48171c28ad0d23d4bdc365e97edb0ad62dd040da47a0c" }, "downloads": -1, "filename": "jpy_flette-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0ed64486fed454a201b0ff440cc5dec2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5.0", "size": 55329, "upload_time": "2018-04-16T01:44:31", "url": "https://files.pythonhosted.org/packages/d8/c4/996bdb386c8ca71a90aa5697e714228c7dc0113a96ce6e58e58fb15fb77a/jpy_flette-0.1.0.tar.gz" } ] }