{ "info": { "author": "Humberto Rocha", "author_email": "humrochagf@gmail.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Environment :: Web Environment", "Framework :: Flask", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Topic :: Multimedia :: Graphics :: Presentation", "Topic :: Text Processing :: Markup :: HTML" ], "description": "# Flask Reveal\n\n[![PyPI](https://img.shields.io/pypi/v/flask-reveal.svg)](https://pypi.org/project/flask-reveal/)\n[![PyPI - License](https://img.shields.io/pypi/l/flask-reveal.svg)](https://pypi.org/project/flask-reveal/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flask-reveal.svg)](https://pypi.org/project/flask-reveal/)\n[![Build Status](https://travis-ci.org/humrochagf/flask-reveal.svg?branch=master)](https://travis-ci.org/humrochagf/flask-reveal)\n[![Coverage Status](https://coveralls.io/repos/github/humrochagf/flask-reveal/badge.svg)](https://coveralls.io/github/humrochagf/flask-reveal)\n[![Code Health](https://landscape.io/github/humrochagf/flask-reveal/master/landscape.svg?style=flat)](https://landscape.io/github/humrochagf/flask-reveal/master)\n\n[flask-reveal](https://github.com/humrochagf/flask-reveal) is a cool way to setup your [reveal.js](https://github.com/hakimel/reveal.js) presentations without the need to edit a monolithic html file and using markdown syntax mixed with some html tags.\n\n## Requirements\n\nThe current version of flask-reveal runs on python 3.x\n\n- Flask\n- reveal.js\n\n## Installation\n\nYou can install it from the PyPI:\n\n```shell\n$ pip install flask-reveal\n```\n\n## Usage\n\n### Running the Presentation\n\nTo start your presentation run:\n\n```shell\n$ flaskreveal start [-m=MEDIA | --media=MEDIA] [-d | --debug] PATH\n```\n\nThe `PATH` is the path to the markdown presentation file.\n\nThe `MEDIA` value sets custom media folder. If not passed, sets to default **img\\** folder inside the presentation folder.\n\n### Creating a new Presentation\n\nTo create a new presentation run:\n\n```shell\n$ flaskreveal mkpresentation [NAME]\n```\n\n### Install/Update reveal.js files\n\nIf you need for some reason reinstall reveal.js files, just run the following command:\n\n```shell\n$ flaskreveal installreveal\n```\n\nIt will download reveal.js from a default **url** and make the install. If you want to set the **url** by yourself:\n\n```shell\n$ flaskreveal installreveal -u URL\n```\n\nIf you already have the reveal.js file:\n\n```shell\n$ flaskreveal installreveal -f FILE\n```\n\nWhere the `FILE` can be either the **.tar.gz** or the **.zip** release file found at the [reveal.js releases](https://github.com/hakimel/reveal.js/releases).\n\n### PDF Export\n\nPresentations can be exported to PDF via a special print stylesheet. This feature will be described using [Google Chrome](https://google.com/chrome) or [Chromium](https://www.chromium.org/Home), but I got the same results using [Firefox](https://www.mozilla.org/en-US/firefox/new/).\n\n1. Run the presentation with flask-reveal.\n2. Open your brownser with the `print-pdf` as query string like : `localhost:5000/?print-pdf`.\n3. Open the in-browser print dialog (CTRL+P or CMD+P).\n4. Change the **Destination** setting to **Save as PDF**.\n5. Change the **Layout** to **Landscape**.\n6. Change the **Margins** to **None**.\n7. Enable the **Background graphics** option.\n8. Click **Save**.\n\nAlternatively you can use the [decktape](https://github.com/astefanutti/decktape) project.\n\n### Share your presentation using [Ngrok](https://ngrok.com/)\n\nYou can easily share your presentation using [Ngrok](https://ngrok.com/). Download it, and put the binary file at root. Then you can do :\n```shell\n$ ngrok http 5000\n```\nThis assume `5000` is your localhost.\n`ngrok` will create a secure tunnel to your localhost :\n\n```shell\nngrok by @inconshreveable (Ctrl+C to quit)\n\nTunnel Status online\nVersion 2.0.19/2.1.1\nWeb Interface http://127.0.0.1:4040\nForwarding http://323744c6.ngrok.io -> localhost:5000\nForwarding https://323744c6.ngrok.io -> localhost:5000\n\nConnections ttl opn rt1 rt5 p50 p90\n 0 0 0.00 0.00 0.00 0.00\n```\n\n## Presentation Setup\n\nThe flask-reveal checks for three things on your presentation folder.\n\n### The 'slides.md' File\n\nThis is your presentation file written using markdown with some especial tags described on [markdown section](#markdown) and is placed on your presentation root folder.\n\nSplit your slides by setting up a *slide separator* into **REVEAL_CONFIG**. Default separator is `---`.\n\n### The 'img' folder\n\nAll images used on your presentation are placed inside the **'img'** folder and referenced on your slides starting from your presentation root.\n\n```markdown\n![Python Logo](img/python.png)\n```\n\n### The 'config.py' File\n\nThe configuration file are placed on the presentation root folder and is responsible to customize your presentation.\n\nThis file is optional and can the values above can be changed:\n\n**REVEAL_META**: python dictionary with metadata from the presentation\n\n```python\nREVEAL_META = {\n # Title of the slide\n 'title': 'The title',\n\n # Author in the metadata of the slide\n 'author': 'Some Author',\n\n # Description in the metadata of the slide\n 'description': 'Some description'\n}\n```\n\n**REVEAL_THEME**: string with reveal theme of choice\n\n```python\n# Themes\n# beige, black, blood, league, moon, night, serif, simple, sky,\n# solarized, white\nREVEAL_THEME = 'black'\n```\n\n**REVEAL_CONFIG**: python dictionary with the [reveal.js configuration attributes](https://github.com/hakimel/reveal.js/#configuration) but using python types (e.g.: true is python boolean True)\n\n```python\nREVEAL_CONFIG = {\n # Slide separator\n 'slideSep': '---',\n\n # Display controls in the bottom right corner\n 'controls': True,\n\n # Display a presentation progress bar\n 'progress': True,\n\n # Display the page number of the current slide\n 'slideNumber': False,\n\n # Push each slide change to the browser history\n 'history': True,\n\n # Enable keyboard shortcuts for navigation\n 'keyboard': True,\n\n # Enable the slide overview mode\n 'overview': True,\n\n # Vertical centering of slides\n 'center': True,\n\n # Enables touch navigation on devices with touch input\n 'touch': True,\n\n # Loop the presentation\n 'loop': False,\n\n # Change the presentation direction to be RTL\n 'rtl': False,\n\n # Turns fragments on and off globally\n 'fragments': True,\n\n # Flags if the presentation is running in an embedded mode,\n # i.e. contained within a limited portion of the screen\n 'embedded': False,\n\n # Flags if we should show a help overlay when the questionmark\n # key is pressed\n 'help': True,\n\n # Flags if speaker notes should be visible to all viewers\n 'showNotes': False,\n\n # Number of milliseconds between automatically proceeding to the\n # next slide, disabled when set to 0, this value can be overwritten\n # by using a data-autoslide attribute on your slides\n 'autoSlide': 0,\n\n # Stop auto-sliding after user input\n 'autoSlideStoppable': True,\n\n # Enable slide navigation via mouse wheel\n 'mouseWheel': False,\n\n # Hides the address bar on mobile devices\n 'hideAddressBar': True,\n\n # Opens links in an iframe preview overlay\n 'previewLinks': False,\n\n # Transition style\n # default/cube/page/concave/zoom/linear/fade/none\n 'transition': 'default',\n\n # Transition speed\n 'transitionSpeed': 'default', # default/fast/slow\n\n # Transition style for full page slide backgrounds\n # default/none/slide/concave/convex/zoom\n 'backgroundTransition': 'default',\n\n # Number of slides away from the current that are visible\n 'viewDistance': 3,\n\n # Parallax background image\n # e.g.:\n # \"'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'\"\n 'parallaxBackgroundImage': '',\n\n # Parallax background size\n 'parallaxBackgroundSize': '', # CSS syntax, e.g. \"2100px 900px\"\n\n # Amount to move parallax background (horizontal and vertical)\n # on slide change\n # Number, e.g. 100\n 'parallaxBackgroundHorizontal': '',\n 'parallaxBackgroundVertical': '',\n}\n```\n\n## Markdown\n\nThe markdown used on the presentation files support most of the [GitHub Markdown](https://help.github.com/articles/markdown-basics) and adds some especial html comment tags to edit styles and control effects that are explained on the [reveal.js markdown docs](https://github.com/hakimel/reveal.js/#markdown).\n\n**Important:** You can use all html tags on the presentation files, but some block tags can present unexpected behavior.\n\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/humrochagf/flask-reveal", "keywords": "flask,reveal.js,presentation", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "flask-reveal", "package_url": "https://pypi.org/project/flask-reveal/", "platform": "any", "project_url": "https://pypi.org/project/flask-reveal/", "project_urls": { "Homepage": "https://github.com/humrochagf/flask-reveal" }, "release_url": "https://pypi.org/project/flask-reveal/0.4.4/", "requires_dist": [ "Flask (>=0.12)" ], "requires_python": "", "summary": "Make reveal.js presentations with Flask", "version": "0.4.4" }, "last_serial": 3713854, "releases": { "0.3": [ { "comment_text": "", "digests": { "md5": "dc20c4dafe573013ca0c3c2e0db8234e", "sha256": "3d2acb9a82f39ba5797961ac51e75dd637a44152773b305193de3be1d61e0bac" }, "downloads": -1, "filename": "flask-reveal-0.3.tar.gz", "has_sig": false, "md5_digest": "dc20c4dafe573013ca0c3c2e0db8234e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13570, "upload_time": "2017-05-20T05:19:02", "url": "https://files.pythonhosted.org/packages/49/bc/8f8d8d2b55398b78f2b9cc481ff408cec051fe49a1ccc3718557fc487837/flask-reveal-0.3.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "ba80c3925944eb8de2410e2ccee2cfbb", "sha256": "cbf716822a3110547c896ea6fe41cb2a571b504cc891859db74662f964024a79" }, "downloads": -1, "filename": "flask_reveal-0.4.0-py2-none-any.whl", "has_sig": false, "md5_digest": "ba80c3925944eb8de2410e2ccee2cfbb", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22706, "upload_time": "2018-03-25T18:03:59", "url": "https://files.pythonhosted.org/packages/16/f1/0fb1ef94492562c4f25086b97c809cb79fa8850aec3934020cf51490456e/flask_reveal-0.4.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cedc40fd380ca5532d69f5ecf843f549", "sha256": "d313ea87d19ac6a2ae32e96385b608a1db7a53128312a4d7fd0f9fa2523a07fb" }, "downloads": -1, "filename": "flask_reveal-0.4.0-py3-none-any.whl", "has_sig": false, "md5_digest": "cedc40fd380ca5532d69f5ecf843f549", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22706, "upload_time": "2018-03-25T18:04:01", "url": "https://files.pythonhosted.org/packages/87/fb/5c3f77a389a198c7eeaba4a2b78adc308fa6c5ff4232e1453120955850bd/flask_reveal-0.4.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d8248a3293d9ba8dfc87254d3eb16af8", "sha256": "4403b5c8b219254107b817aa673698325348d3af7515a42c4feca48a1b0d5f56" }, "downloads": -1, "filename": "flask-reveal-0.4.0.tar.gz", "has_sig": false, "md5_digest": "d8248a3293d9ba8dfc87254d3eb16af8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15199, "upload_time": "2018-03-25T18:04:02", "url": "https://files.pythonhosted.org/packages/bd/58/2679bccc4ac3717b9574888a0946d1a5fe2dae115902d9814cf0f5b6e954/flask-reveal-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "7b2ae4143d73ba53557df9c96f853d64", "sha256": "9c7476b8471b5f9697d057ac1855ce525ca0de5aa4c11a4b1225464ccc4866f3" }, "downloads": -1, "filename": "flask_reveal-0.4.1-py2-none-any.whl", "has_sig": false, "md5_digest": "7b2ae4143d73ba53557df9c96f853d64", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22700, "upload_time": "2018-03-25T18:20:18", "url": "https://files.pythonhosted.org/packages/ca/22/3fef1d7e0a9e33f97070184944c6bcdaece602c9c4c83922cbe1df0fa37e/flask_reveal-0.4.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "463626fc83ff8b29faa2c1ca42e73fdf", "sha256": "ffa817edb7738ac427756741af396413cd18fb2b082eabe7a0872da6296d2ea2" }, "downloads": -1, "filename": "flask_reveal-0.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "463626fc83ff8b29faa2c1ca42e73fdf", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22700, "upload_time": "2018-03-25T18:20:20", "url": "https://files.pythonhosted.org/packages/7c/d1/2beb11078deb20febf17fb2051e78e4a385dda1008bd83718e136507c498/flask_reveal-0.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "37f585877e76d9df87d9cd7b773bba95", "sha256": "e9b7e39103d293aa9a525acfe384bec8a5562aade75239ef5d15f31108d3c186" }, "downloads": -1, "filename": "flask-reveal-0.4.1.tar.gz", "has_sig": false, "md5_digest": "37f585877e76d9df87d9cd7b773bba95", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15220, "upload_time": "2018-03-25T18:20:22", "url": "https://files.pythonhosted.org/packages/98/21/03700b5f14196120dcd71cb07d6901f8d902bff7211dd1ce22b185c42bb5/flask-reveal-0.4.1.tar.gz" } ], "0.4.2": [ { "comment_text": "", "digests": { "md5": "07e0f48cf0f5492044dc0b7e29845c0c", "sha256": "ff070cf7aebc75bf4cc4250b4f56b5ce4f548379eff9da92af5533f02171d4a8" }, "downloads": -1, "filename": "flask_reveal-0.4.2-py2-none-any.whl", "has_sig": false, "md5_digest": "07e0f48cf0f5492044dc0b7e29845c0c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22456, "upload_time": "2018-03-28T13:24:38", "url": "https://files.pythonhosted.org/packages/f9/31/e2aa9312683788bb04dd2717f62ca2adff4b91972dbb1237e8301abe9f18/flask_reveal-0.4.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a9531f6d3a32bdbc004128c33e108b81", "sha256": "edba991feff073f8c77218b9e8455b54d8b8c1c8ad85caf5bb699a93f72d0e36" }, "downloads": -1, "filename": "flask_reveal-0.4.2-py3-none-any.whl", "has_sig": false, "md5_digest": "a9531f6d3a32bdbc004128c33e108b81", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22455, "upload_time": "2018-03-28T13:24:39", "url": "https://files.pythonhosted.org/packages/f2/99/f44a8d477b9dae0585a75e237ad25169ed060bfb0566231dddb929d59ee2/flask_reveal-0.4.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a1b345d703d2d590fe9038cc761297a6", "sha256": "8234f0dd037f4ded861d4755ac5482611de2000d29ab9025d49676a3c4c81f1b" }, "downloads": -1, "filename": "flask-reveal-0.4.2.tar.gz", "has_sig": false, "md5_digest": "a1b345d703d2d590fe9038cc761297a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14819, "upload_time": "2018-03-28T13:24:41", "url": "https://files.pythonhosted.org/packages/dd/6b/dcb5a55225b20f6cc3ce0e982b40a7783c7c6022093031319a58e1957e38/flask-reveal-0.4.2.tar.gz" } ], "0.4.3": [ { "comment_text": "", "digests": { "md5": "6ec94de7fd869acebf32754c2d3ed3b4", "sha256": "a195fd74d02823ee213189c2325474f350d55ce48432633cef059e94b3907ba3" }, "downloads": -1, "filename": "flask_reveal-0.4.3-py2-none-any.whl", "has_sig": false, "md5_digest": "6ec94de7fd869acebf32754c2d3ed3b4", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22457, "upload_time": "2018-03-28T13:41:40", "url": "https://files.pythonhosted.org/packages/c2/00/bc247e9dd757b010d735993a4e2de29905849e5a6ee7098060650c5ba265/flask_reveal-0.4.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "12cd2a2ee6eced964f3b670ba684a8b2", "sha256": "aa2d94936124a5619c4831ca076b648507727b17391bbd900de6ebf5a15080ea" }, "downloads": -1, "filename": "flask_reveal-0.4.3-py3-none-any.whl", "has_sig": false, "md5_digest": "12cd2a2ee6eced964f3b670ba684a8b2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22459, "upload_time": "2018-03-28T13:41:42", "url": "https://files.pythonhosted.org/packages/55/1a/7aeace1fac8ad4e1639da47e067fd8d0f0cb9079745d2645e167840e6e49/flask_reveal-0.4.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "89c4e6c6d87f65d95277b1b1ac972901", "sha256": "30c2ac6792f34cc8a29bcf0ebbd4d7d228310e355f09f63ebd8d5b9653dbe258" }, "downloads": -1, "filename": "flask-reveal-0.4.3.tar.gz", "has_sig": false, "md5_digest": "89c4e6c6d87f65d95277b1b1ac972901", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14811, "upload_time": "2018-03-28T13:41:47", "url": "https://files.pythonhosted.org/packages/6d/05/6f71c704941d48e563c55a46a3f630a12c85fd7b2ca4d879051f2068f75d/flask-reveal-0.4.3.tar.gz" } ], "0.4.4": [ { "comment_text": "", "digests": { "md5": "d579a85b7580e00ec2c8a292c474e1c3", "sha256": "d2b25101277b1a8bdf0770f2d17fa7cb2e83212662a0dbb8cef084d57b132f29" }, "downloads": -1, "filename": "flask_reveal-0.4.4-py2-none-any.whl", "has_sig": false, "md5_digest": "d579a85b7580e00ec2c8a292c474e1c3", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22433, "upload_time": "2018-03-28T13:48:43", "url": "https://files.pythonhosted.org/packages/fd/3e/4538fab9c1a3917f64eb5e00c6c721e09f45fc558ae0f19034c1303bedb6/flask_reveal-0.4.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e8cc8197724a25ddeb1d4e35ce0e63c", "sha256": "8e74dfac41f631c90a9ff5ee80c448ae9ab6eb22d32ba96f5d039474bdc7b862" }, "downloads": -1, "filename": "flask_reveal-0.4.4-py3-none-any.whl", "has_sig": false, "md5_digest": "9e8cc8197724a25ddeb1d4e35ce0e63c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22432, "upload_time": "2018-03-28T13:48:48", "url": "https://files.pythonhosted.org/packages/8e/c8/55b27889d13d10d0e3fd92a1b0307a846d989dea9b7c8c37ca6134586a5a/flask_reveal-0.4.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "995d9b402d718283a7ed3549097934ac", "sha256": "f400559f110f7c2e7b5ce650e0c33265bd436be3899c75c9d25d36173e40d4c2" }, "downloads": -1, "filename": "flask-reveal-0.4.4.tar.gz", "has_sig": false, "md5_digest": "995d9b402d718283a7ed3549097934ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14787, "upload_time": "2018-03-28T13:48:49", "url": "https://files.pythonhosted.org/packages/2e/bc/444c0057db75d624f268ed47dfe2a0efe634ca33b4d2a63534980fa90c66/flask-reveal-0.4.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d579a85b7580e00ec2c8a292c474e1c3", "sha256": "d2b25101277b1a8bdf0770f2d17fa7cb2e83212662a0dbb8cef084d57b132f29" }, "downloads": -1, "filename": "flask_reveal-0.4.4-py2-none-any.whl", "has_sig": false, "md5_digest": "d579a85b7580e00ec2c8a292c474e1c3", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 22433, "upload_time": "2018-03-28T13:48:43", "url": "https://files.pythonhosted.org/packages/fd/3e/4538fab9c1a3917f64eb5e00c6c721e09f45fc558ae0f19034c1303bedb6/flask_reveal-0.4.4-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9e8cc8197724a25ddeb1d4e35ce0e63c", "sha256": "8e74dfac41f631c90a9ff5ee80c448ae9ab6eb22d32ba96f5d039474bdc7b862" }, "downloads": -1, "filename": "flask_reveal-0.4.4-py3-none-any.whl", "has_sig": false, "md5_digest": "9e8cc8197724a25ddeb1d4e35ce0e63c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22432, "upload_time": "2018-03-28T13:48:48", "url": "https://files.pythonhosted.org/packages/8e/c8/55b27889d13d10d0e3fd92a1b0307a846d989dea9b7c8c37ca6134586a5a/flask_reveal-0.4.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "995d9b402d718283a7ed3549097934ac", "sha256": "f400559f110f7c2e7b5ce650e0c33265bd436be3899c75c9d25d36173e40d4c2" }, "downloads": -1, "filename": "flask-reveal-0.4.4.tar.gz", "has_sig": false, "md5_digest": "995d9b402d718283a7ed3549097934ac", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14787, "upload_time": "2018-03-28T13:48:49", "url": "https://files.pythonhosted.org/packages/2e/bc/444c0057db75d624f268ed47dfe2a0efe634ca33b4d2a63534980fa90c66/flask-reveal-0.4.4.tar.gz" } ] }