{ "info": { "author": "David Handy", "author_email": "cpif@handysoftware.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "License :: OSI Approved :: BSD License", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows :: Windows 10", "Operating System :: Microsoft :: Windows :: Windows 7", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation", "Topic :: Text Processing :: Markup :: HTML" ], "description": "========\nrstwatch\n========\n------------------------------------------------------------\nWatch directories for changes to RST files and generate HTML\n------------------------------------------------------------\n\n:Author: David Handy \n\nThis simple static website generator scans directories for .rst files (text\nfiles in reStructuredText_ format) and converts them to HTML documents using\ndocutils_. By default it runs continuously. Whenever an .rst file (or a\nfile included by an .rst file) is added or changed, the associated .html\nfile is immediately created or re-generated.\n\n.. _reStructuredText: http://docutils.sourceforge.net/rst.html\n.. _docutils: http://docutils.sourceforge.net/index.html\n\nExample\n=======\n\n- In your web content directory run: ``rstwatch .``\n- Create an .rst file in that directory, e.g. named ``index.rst``\n- *Immediately a file named* ``index.html`` *appears in that same directory*\n- Point your web browser to the ``index.html`` file\n- In your editor window, make a change to ``index.rst`` and save it\n- In your browser window, hit the refresh button\n- **Boom!** *You see your changes, converted to HTML, right away*\n- When you are done, press ``Ctrl-C`` to stop ``rstwatch``\n\nYou can use ``rstwatch`` to learn and experiment with docutils_ and the\nreStructuredText_ format. This can be a stepping-stone to using a more\ncomplicated, fully-featured document generation system based on docutils,\nsuch as Sphinx_.\n\n.. _Sphinx: http://www.sphinx-doc.org/en/stable/index.html\n\nInstallation Instructions\n=========================\n\n``rstwatch`` is an `open source`_ program written in the Python_ programming\nlanguage. (See the `license `_.)\n\nFirst, install Python if you haven't already. It is freely available for\nWindows_, MacOS_, and Linux (it is likely already installed on MacOS or\nLinux.)\n\nNext, install ``rstwatch`` from the `Python Package Index`_ using the pip_\ncommand::\n\n pip install rstwatch\n\nThe source code is hosted at: https://sourceforge.net/projects/rstwatch/\n\n.. _`open source`: https://opensource.org/\n.. _Python: https://www.python.org/\n.. _Windows: https://www.python.org/downloads/windows/\n.. _MacOS: https://www.python.org/downloads/mac-osx/\n.. _`Python Package Index`: https://pypi.python.org/pypi\n.. _pip: https://pip.pypa.io/en/stable/\n\nUsage\n=====\n\n::\n\n rstwatch [options] ...\n\nOptions:\n\n--exit Exit after first pass, instead of repeat scanning\n--interval=SECONDS Seconds to delay between directory scans [default: 2.0]\n--log-config=FILENAME (Optional) Custom logging configuration file\n--refresh Regenerate all html files on first scan\n--writer=WRITER_NAME Docutils writer name. [default: html5]\n\nFor the (optional) log configuration file format, see:\nhttps://docs.python.org/3/library/logging.config.html#configuration-file-format\n\nExample log config file: `log-config.ini `__\n\nRelated Links\n=============\n\n- `rstwatch on bitbucket\n `__\n- `reStructuredText quick reference\n `__\n- `List of built-in reStructuredText directives\n `__\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://bitbucket.org/dhandy2013/rstwatch/get/tip.zip", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/dhandy2013/rstwatch", "keywords": "", "license": "BSD-2-Clause", "maintainer": "", "maintainer_email": "", "name": "rstwatch", "package_url": "https://pypi.org/project/rstwatch/", "platform": "", "project_url": "https://pypi.org/project/rstwatch/", "project_urls": { "Download": "https://bitbucket.org/dhandy2013/rstwatch/get/tip.zip", "Homepage": "https://bitbucket.org/dhandy2013/rstwatch" }, "release_url": "https://pypi.org/project/rstwatch/1.0.3/", "requires_dist": [ "docopt (>=0.5.0)", "docutils (>=0.13)" ], "requires_python": "", "summary": "Watch directories for changes to RST files and generate HTML", "version": "1.0.3" }, "last_serial": 5713010, "releases": { "1.0.2": [ { "comment_text": "", "digests": { "md5": "91a79a9f3ee02d2746c1f76e3fb66236", "sha256": "6205a0460a522ea2f3fdf71196502216eabdd982b3016ac685f3e6a14b5f780f" }, "downloads": -1, "filename": "rstwatch-1.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "91a79a9f3ee02d2746c1f76e3fb66236", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 10107, "upload_time": "2017-08-18T00:55:32", "url": "https://files.pythonhosted.org/packages/9b/27/a286acc5f3c1eafecf240242086e2e7187398294d3f329d499e3ea8005fe/rstwatch-1.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b3380f42d3e81553a1d94a58271735a6", "sha256": "537cc4b39f0985c7e157ecdeb0db9c33430fddfcff7ee59eb7a15b924629a2d7" }, "downloads": -1, "filename": "rstwatch-1.0.2.tar.gz", "has_sig": false, "md5_digest": "b3380f42d3e81553a1d94a58271735a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12335, "upload_time": "2017-08-18T00:55:34", "url": "https://files.pythonhosted.org/packages/3a/b7/74dea9023afd4f9ebb0fed0b700c820336df3f2ff348c72ea043f69c30b0/rstwatch-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "86408a56c1373b7ae8893549f6953aa9", "sha256": "6728732ffc4af92b598acc480c6d3785766d4393cf87fe95d5b7f04f3640082e" }, "downloads": -1, "filename": "rstwatch-1.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86408a56c1373b7ae8893549f6953aa9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8555, "upload_time": "2019-08-22T03:35:45", "url": "https://files.pythonhosted.org/packages/12/58/a2405e282b4ea1344118fa707158d3a385c29586d01ab16b28d6ef0f887c/rstwatch-1.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36dacaddf1568744e81fb66175497b3a", "sha256": "28cc43ca4c3a470088d004a9c48643a16e60ab4fb6db75a8f8e1d0e7d3d117ef" }, "downloads": -1, "filename": "rstwatch-1.0.3.tar.gz", "has_sig": false, "md5_digest": "36dacaddf1568744e81fb66175497b3a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11047, "upload_time": "2019-08-22T03:35:54", "url": "https://files.pythonhosted.org/packages/95/32/249124fc06c768565906cb2a83c118b0b2993dad932137c19f80ac0636ae/rstwatch-1.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "86408a56c1373b7ae8893549f6953aa9", "sha256": "6728732ffc4af92b598acc480c6d3785766d4393cf87fe95d5b7f04f3640082e" }, "downloads": -1, "filename": "rstwatch-1.0.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "86408a56c1373b7ae8893549f6953aa9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8555, "upload_time": "2019-08-22T03:35:45", "url": "https://files.pythonhosted.org/packages/12/58/a2405e282b4ea1344118fa707158d3a385c29586d01ab16b28d6ef0f887c/rstwatch-1.0.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "36dacaddf1568744e81fb66175497b3a", "sha256": "28cc43ca4c3a470088d004a9c48643a16e60ab4fb6db75a8f8e1d0e7d3d117ef" }, "downloads": -1, "filename": "rstwatch-1.0.3.tar.gz", "has_sig": false, "md5_digest": "36dacaddf1568744e81fb66175497b3a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11047, "upload_time": "2019-08-22T03:35:54", "url": "https://files.pythonhosted.org/packages/95/32/249124fc06c768565906cb2a83c118b0b2993dad932137c19f80ac0636ae/rstwatch-1.0.3.tar.gz" } ] }