{ "info": { "author": "Jean-Christophe Fabre", "author_email": "jean-christophe.fabre@inra.fr", "bugtrack_url": null, "classifiers": [], "description": "###############################\nDeveal, a reveal.js helper tool\n###############################\n\n\nDeveal is an helper tool for using the marvelous `reveal.js presentation framework `_.\n\nIt provides the ability to\n\n* create a new presentation\n* split presentation into multiple files\n* easily parameterize the presentation (title, theme, custom css, ...)\n* build presentation into a single index.html file\n* watch for presentation updates while editing the source files\n\n\nDeveal is developped in Python 3 and mainly relies on the wonderful\n`Jinja2 `_, `PyYaml `_ and `watchdog `_ packages.\n\n\n\nInstallation\n============\n\nUse the pip installation tool\n\n.. code-block:: shell\n\n pip install deveal\n\nThe dependencies will be automatically installed.\n\n\nUsage\n=====\n\nDeveal is a command line tool. It must be used from within a terminal.\n\nRun the following command to get help\n\n.. code-block:: shell\n\n deveal --help\n\n\ndeveal new\n----------\n\nThe ``deveal new`` command creates a new presentation.\nAs it creates the presentation directory itself, the command must be run in the upper directory where the new presentation will be created\n\n(example below for creating a new presentation named \"mynewpresent\")\n\n.. code-block:: shell\n\n deveal new mynewpresent\n\n\nThis command creates the minimal required files in the presentation directory\n\n* the **deveal-index.html** template file\n* the **deveal.yaml** configuration file\n\nA **deveal.css** file for optional custom styles and a **sections** directory with an example presentation are also created\n\nThe deveal-index.html file is the template for the presentation.\nIt a Jinja2 template rendered throught the ``deveal build`` command, using the variables contained in the deveal.yaml file.\nUnless you want to modify the reveal.js configuration, you should not have to modify this template.\n\nThe deveal.yaml file contains the configuration for the presentation. It should contains the folling expected variables:\n\n* reveal_path : The path or URL to the installed reveal.js framework (\"https://cdn.jsdelivr.net/npm/reveal.js@3.6.0\" if not defined)\n* reveal_theme : The theme to use for (\"black\" if not defined)\n* content_files : The ordered array of files containing the parts of the presentation\n* custom_css : The path to the custom css file if any\n\nAny other variable defined in this file is made available as a Jinja2 variable for the template file.\nThis may be useful if you plan to customize the template.\n\n\n\ndeveal build\n------------\n\nThe ``deveal build`` command builds the presentation as a single **index.html** file using the deveal-index.html and deveal.yaml files\n\n.. code-block:: shell\n\n deveal build\n\nThe obtained index.html file is the presentation itself that can be open throught a web browser.\n\n\ndeveal watch\n------------\n\nThe ``deveal watch`` command watches for files changes in the presentation directory and subdirectories.\nIf a change is detected, a build is automatically triggered. Type ``Ctrl+C`` to stop watching.\n\n.. code-block:: shell\n\n deveal watch\n\n\nTips\n----\n\n* For an easier writing and maintenance of the presentation, it is encouraged to split the presentation into multiple files (for example title.html, part1.html, part2.html, ...)\n* it is encouraged to put the graphics used in the presentation in a dedicated subdirectory (named \"graphics\" for example)\n\n\nAuthors\n=======\n\nDeveal is developed by `Jean-Christophe Fabre `_\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/fabrejc/deveal", "keywords": "", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "deveal", "package_url": "https://pypi.org/project/deveal/", "platform": "", "project_url": "https://pypi.org/project/deveal/", "project_urls": { "Homepage": "http://github.com/fabrejc/deveal" }, "release_url": "https://pypi.org/project/deveal/0.3.0/", "requires_dist": [ "argparse", "jinja2 (>=2.7)", "PyYAML", "watchdog" ], "requires_python": "~=3.5", "summary": "A reveal.js helper tool", "version": "0.3.0" }, "last_serial": 5971877, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "6e186771e5699e4edb0832f9b51614f0", "sha256": "cb7c386abf698a905ef4d3ca1aa5ddac0228aa8dc121c1f93d6a892b110f9b17" }, "downloads": -1, "filename": "deveal-0.0.1.tar.gz", "has_sig": false, "md5_digest": "6e186771e5699e4edb0832f9b51614f0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2047, "upload_time": "2018-01-11T21:28:50", "url": "https://files.pythonhosted.org/packages/8f/25/27a920d78a3ca85c129d37f0b3c36333c799d1d8fbda864a93ee9af44c72/deveal-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "a5db19748ef83f6c0ee95e4e0a112d45", "sha256": "b616dd80a937e32c6ac27dd7a309344f0d75fa0b5db726b9e37227f8dfa54c42" }, "downloads": -1, "filename": "deveal-0.0.2.tar.gz", "has_sig": false, "md5_digest": "a5db19748ef83f6c0ee95e4e0a112d45", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3379, "upload_time": "2018-01-12T09:22:35", "url": "https://files.pythonhosted.org/packages/0d/60/db47fb0ef567cd6320776f6e6f4284ac4b436540ca0674d772b38090e06c/deveal-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "7ced2293d79758dce1c42266dc4cb0d2", "sha256": "b56b6bb4ae23ab93db1d45fcfd55e8125fcf46e3bfad66c63b907efc10994456" }, "downloads": -1, "filename": "deveal-0.0.3.tar.gz", "has_sig": false, "md5_digest": "7ced2293d79758dce1c42266dc4cb0d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3389, "upload_time": "2018-01-12T14:05:18", "url": "https://files.pythonhosted.org/packages/07/7e/91eb6c0bdf3bab080020de794addf31b7e155a841bc14916d938b158fb66/deveal-0.0.3.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "adea9cc09430751c3cddc78428c9e59b", "sha256": "c230b4d6f39a3757495c7a764b3fd1db4da59a0f8871379ad114d7d4154c41c0" }, "downloads": -1, "filename": "deveal-0.0.5.tar.gz", "has_sig": false, "md5_digest": "adea9cc09430751c3cddc78428c9e59b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3452, "upload_time": "2018-01-12T15:09:32", "url": "https://files.pythonhosted.org/packages/cf/97/eab30d31b82002863a6c9ce8dd8aeb6b99c97dae960b054acff20d45a8ab/deveal-0.0.5.tar.gz" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "339ebe5c46575715d82f9df17d42f7d4", "sha256": "f54709a64c21e58905424b42932d7271edee058daeac861ece5b086282c1b24b" }, "downloads": -1, "filename": "deveal-0.1.0.tar.gz", "has_sig": false, "md5_digest": "339ebe5c46575715d82f9df17d42f7d4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3840, "upload_time": "2018-01-12T16:05:23", "url": "https://files.pythonhosted.org/packages/5e/94/171ab2c646af5523eb8789c277fa4a2c8dbb69e2f9e579a73df730fd1f3f/deveal-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "80e56d4ab1486ddd0ea4b62e3695b961", "sha256": "d2d774da67c152b009d443d2aa381b8e22c8a921f77788370a84c65736a3e559" }, "downloads": -1, "filename": "deveal-0.1.1.tar.gz", "has_sig": false, "md5_digest": "80e56d4ab1486ddd0ea4b62e3695b961", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2672, "upload_time": "2018-01-14T20:23:44", "url": "https://files.pythonhosted.org/packages/64/82/45735645defb7c5324abe236e4c89b654da31117b29f761754164cf5780c/deveal-0.1.1.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "4b3f93877b85097800b4576daa2f8e96", "sha256": "93d8945b1f1539796b3d0f0d561b6235c189f00cc811f4156d3c68f5a898c1f8" }, "downloads": -1, "filename": "deveal-0.1.3.tar.gz", "has_sig": false, "md5_digest": "4b3f93877b85097800b4576daa2f8e96", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2968, "upload_time": "2018-01-16T19:06:07", "url": "https://files.pythonhosted.org/packages/70/36/e3f2e2b76557b7e79d002e526980c24ff2729e208148c03bbac01bf5aca9/deveal-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "e7abfd47b37d4cdb61b6be495ddba7d8", "sha256": "37af3cc55c7117054fe78483a1cef684b60f1d7fde7f47e456733568df8423f6" }, "downloads": -1, "filename": "deveal-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e7abfd47b37d4cdb61b6be495ddba7d8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4178, "upload_time": "2018-01-16T19:18:20", "url": "https://files.pythonhosted.org/packages/83/e9/f1049ac3f8d6c7f4482a19a1c007947cfd7fb0f0e2fe4b9e73d03c01684c/deveal-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "8bf539273b9fdbc036b2238c53542d9d", "sha256": "6d2e336e58487b5c442c853529525a2f800e5ab0af01076669050aae7c70dabc" }, "downloads": -1, "filename": "deveal-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "8bf539273b9fdbc036b2238c53542d9d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8495, "upload_time": "2018-05-30T06:58:13", "url": "https://files.pythonhosted.org/packages/83/d3/d5fc15301d2ff6048efe7554260cfd15a034fadeb8d342c8655f5f6142ad/deveal-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9836696a5cc4fab0c3f733f0d0f2a80f", "sha256": "27784e85c8ee783dcd40f459bbd23339a0ee390c3eeaa8e5f261f76b638813ff" }, "downloads": -1, "filename": "deveal-0.2.1.tar.gz", "has_sig": false, "md5_digest": "9836696a5cc4fab0c3f733f0d0f2a80f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4204, "upload_time": "2018-05-30T06:58:14", "url": "https://files.pythonhosted.org/packages/c6/6e/ee894074fc8d6b2bb309374950965eaee4fe8869439038c859bae374d3d7/deveal-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "3217882f64e605e683619cc93d66f28d", "sha256": "fe16c837ebeb86ca145ccdb202b564eb0a66f940aca4f334f2c912a9958a31ed" }, "downloads": -1, "filename": "deveal-0.2.2.macosx-10.13-x86_64.tar.gz", "has_sig": false, "md5_digest": "3217882f64e605e683619cc93d66f28d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7360, "upload_time": "2018-06-12T12:34:21", "url": "https://files.pythonhosted.org/packages/e4/ea/b6cf891a2908cd199ebd021522fcea33dcb27c5372696a0ab0f3a000c69a/deveal-0.2.2.macosx-10.13-x86_64.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "c2aa7f58daaddc0505d7a92e60c256ad", "sha256": "bc32d57e3841292b1443400843ef1171454b3857c8fff617397d415b62c8e2c0" }, "downloads": -1, "filename": "deveal-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c2aa7f58daaddc0505d7a92e60c256ad", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.5", "size": 6398, "upload_time": "2019-10-14T14:35:45", "url": "https://files.pythonhosted.org/packages/4d/b8/ad9cad3a4e20b854cb1e5452bb73f1b95ec80d5d1305eddc18bc28bf0d2d/deveal-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a6baf1c9bf422aea4ff0220b0e0dd04", "sha256": "366d5c20586b94c775e3ab5bafc229aa3d40c9d1c30f212acef858bbbec945f4" }, "downloads": -1, "filename": "deveal-0.3.0.tar.gz", "has_sig": false, "md5_digest": "7a6baf1c9bf422aea4ff0220b0e0dd04", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.5", "size": 5524, "upload_time": "2019-10-14T14:35:47", "url": "https://files.pythonhosted.org/packages/17/df/e046bcffe219d5be710760456300e91e78ae7ed8db943536b760800f3977/deveal-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "c2aa7f58daaddc0505d7a92e60c256ad", "sha256": "bc32d57e3841292b1443400843ef1171454b3857c8fff617397d415b62c8e2c0" }, "downloads": -1, "filename": "deveal-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c2aa7f58daaddc0505d7a92e60c256ad", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": "~=3.5", "size": 6398, "upload_time": "2019-10-14T14:35:45", "url": "https://files.pythonhosted.org/packages/4d/b8/ad9cad3a4e20b854cb1e5452bb73f1b95ec80d5d1305eddc18bc28bf0d2d/deveal-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7a6baf1c9bf422aea4ff0220b0e0dd04", "sha256": "366d5c20586b94c775e3ab5bafc229aa3d40c9d1c30f212acef858bbbec945f4" }, "downloads": -1, "filename": "deveal-0.3.0.tar.gz", "has_sig": false, "md5_digest": "7a6baf1c9bf422aea4ff0220b0e0dd04", "packagetype": "sdist", "python_version": "source", "requires_python": "~=3.5", "size": 5524, "upload_time": "2019-10-14T14:35:47", "url": "https://files.pythonhosted.org/packages/17/df/e046bcffe219d5be710760456300e91e78ae7ed8db943536b760800f3977/deveal-0.3.0.tar.gz" } ] }