{ "info": { "author": "Andy Craze", "author_email": "acraze@discogsinc.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "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 :: Utilities" ], "description": "========\r\nOverview\r\n========\r\n\r\n\r\n\r\nUsing a Python BDD test runner like `behave`_, create living\r\ndocumentation from your BDD feature files. This library will create\r\ndocuments that contain up-to-date information about your BDD specs and\r\nhelps generate a static site for your living documentation.\r\n\r\nCurrent supported document types:\r\n\r\n- \\*.mmark files (to be used by `Hugo`_)\r\n\r\nInstallation\r\n------------\r\n\r\n::\r\n\r\n pip install livingdocs\r\n\r\nYou should also install the Hugo binaries in order to generate your\r\nstatic site: https://gohugo.io/overview/installing/\r\n\r\nQuick Start\r\n-----------\r\n\r\nUse the CLI command ``livingdocs`` to configure your Hugo site:\r\n\r\n::\r\n\r\n $ livingdocs\r\n Your site's title: \r\n Your site's description: \r\n ....\r\n\r\nThis will create a ``livingdocs`` folder in your root directory which\r\nwill have a Hugo skeleton to create a static site.\r\n\r\nUsing a test runner like `behave`_, you can generate documents for each\r\nfeature, scenario and step. In **environment.py**, you can use the\r\nDocsMaker to capture this information:\r\n\r\n::\r\n\r\n from livingdocs.maker import DocsMaker\r\n\r\n def before_all(context):\r\n context.docs = DocsMaker('feature')\r\n\r\n def before_scenario(context, scenario):\r\n context.docs.start_scenario(context, scenario)\r\n\r\n def after_scenario(context, scenario):\r\n context.docs.end_scenario(context, scenario)\r\n\r\n def before_feature(context, feature):\r\n context.docs.start_feature(context, feature)\r\n\r\n def after_feature(context, feature):\r\n context.docs.end_feature(context, feature)\r\n\r\n def before_step(context, step):\r\n context.docs.start_step(context, step)\r\n\r\n def after_step(context, step):\r\n \"\"\"\r\n if context.browser is an instance\r\n of Selenium Webdriver, then it will\r\n take a snapshot of this step.\r\n \"\"\"\r\n context.docs.end_step(context, step)\r\n \r\n\r\nDevelopment\r\n-----------\r\n\r\nFirst create a virtual env, then to run the tests use:\r\n\r\n::\r\n\r\n tox -e py27\r\n\r\nLicense\r\n-------\r\n\r\n- BSD License\r\n\r\n.. _behave: http://pythonhosted.org/behave/\r\n.. _Hugo: https://gohugo.io/\r\n\r\n\r\nChangelog\r\n=========\r\n\r\n0.2.0 (2016-09-16)\r\n-----------------------------------------\r\n\r\n* Feature - added cli command to generate static site\r\n\r\n0.1.3 (2016-09-13)\r\n-----------------------------------------\r\n\r\n* Bugfix - Feature filename path can be nested directories\r\n\r\n0.1.2 (2016-08-21)\r\n-----------------------------------------\r\n\r\n* Don't include Pillow (or PIL) in basic install setup.\r\n\r\n0.1.1 (2016-08-21)\r\n-----------------------------------------\r\n\r\n* Requirements are installed during setup.\r\n\r\n0.1.0 (2016-08-21)\r\n-----------------------------------------\r\n\r\n* First release on PyPI.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/discogs/python-livingdocs", "keywords": "bdd,documentation,tools", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "livingdocs", "package_url": "https://pypi.org/project/livingdocs/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/livingdocs/", "project_urls": { "Homepage": "https://github.com/discogs/python-livingdocs" }, "release_url": "https://pypi.org/project/livingdocs/0.2.0/", "requires_dist": [ "awesome-slugify", "click" ], "requires_python": "", "summary": "Create living documentation from BDD specs", "version": "0.2.0" }, "last_serial": 2347483, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "b5bdbcc4ab8f6bc5c7aaa391d6d22b16", "sha256": "b8ad9348280c810a1cf9ebb9627d86e2d4a56375c4f032e5a16b09c7720f3189" }, "downloads": -1, "filename": "livingdocs-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "b5bdbcc4ab8f6bc5c7aaa391d6d22b16", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8439, "upload_time": "2016-08-21T22:43:28", "url": "https://files.pythonhosted.org/packages/53/f6/d807853dfa5cc0eee338e96b640d22e3a3c1532e940595ae9e1a8186e155/livingdocs-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3d9a701c491b806fe7c3ec8d42d7b91a", "sha256": "6a4f21a6a2ef153e3fc169dabcb111776d804732ab2bf160247b91800a8d0811" }, "downloads": -1, "filename": "livingdocs-0.1.0.tar.gz", "has_sig": false, "md5_digest": "3d9a701c491b806fe7c3ec8d42d7b91a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14029, "upload_time": "2016-08-21T22:43:31", "url": "https://files.pythonhosted.org/packages/de/ee/87bbc6e6a44563306e15994e937111d45b79364a45e8a99acb764528ec44/livingdocs-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "e755f84d517b22f9ce9be0437e813ace", "sha256": "e71d0b2a00a514d9dc8994ad91873a4706418722457d087b082f5cee99a1f3c8" }, "downloads": -1, "filename": "livingdocs-0.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e755f84d517b22f9ce9be0437e813ace", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6762, "upload_time": "2016-08-21T23:54:24", "url": "https://files.pythonhosted.org/packages/cb/01/3daa7e4ed1f1f26d2b03231288328cfc42994512954923d6d499148a7244/livingdocs-0.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "201d5a5078da1ae63efbc9df5a06e497", "sha256": "ba015d932df538436dfd129c0ee3badca006401d8180daf0fbe7f73367bb25d5" }, "downloads": -1, "filename": "livingdocs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "201d5a5078da1ae63efbc9df5a06e497", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11152, "upload_time": "2016-08-21T23:54:27", "url": "https://files.pythonhosted.org/packages/ac/97/00db531a7face6adb0fea1099e8f452ca94474ed4d552b6fd4a36b58cbdb/livingdocs-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "74e50a11be095811a794655e9d9a83b1", "sha256": "cf3742de5194f3b6d18a6fb38da6b629741a2b21d36581b73b12d5d1108eeb23" }, "downloads": -1, "filename": "livingdocs-0.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "74e50a11be095811a794655e9d9a83b1", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 8468, "upload_time": "2016-08-22T00:23:53", "url": "https://files.pythonhosted.org/packages/d2/bf/847a2d7a0b50094b62defa59b49426a03089078ae057d10a1d4224a297d3/livingdocs-0.1.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fd81c69bb1ff6f3ad4fddcb100074865", "sha256": "af80c5f5e429ed737af70f98c0484c22622ee5ecaf9c5da9b0fd73bec1ab2649" }, "downloads": -1, "filename": "livingdocs-0.1.2.tar.gz", "has_sig": false, "md5_digest": "fd81c69bb1ff6f3ad4fddcb100074865", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12785, "upload_time": "2016-08-22T00:23:55", "url": "https://files.pythonhosted.org/packages/1b/2b/7e3b1de2ca8cd6c531f9964d75bc697cd45e121ab91d16f02f7af6e91b53/livingdocs-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "42c9a7f1a3de5f4dab4b8af6ca28d150", "sha256": "68cee499422b1088bf125f023a2930ac43974f7c8cc355c8889698b9193c31d8" }, "downloads": -1, "filename": "livingdocs-0.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "42c9a7f1a3de5f4dab4b8af6ca28d150", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 9101, "upload_time": "2016-09-13T18:24:52", "url": "https://files.pythonhosted.org/packages/dd/4d/5e8cf170fdf351c375ebe6c5b598d9caec60846a63740ad1ffd1213f53d6/livingdocs-0.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "76cfe29d86edaacc2156376e54d4121e", "sha256": "0f89b9695d9f25411153aa8bf78e3094f090dc55b8c628bccc182037ca25cfad" }, "downloads": -1, "filename": "livingdocs-0.1.3.tar.gz", "has_sig": false, "md5_digest": "76cfe29d86edaacc2156376e54d4121e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 14827, "upload_time": "2016-09-13T18:24:55", "url": "https://files.pythonhosted.org/packages/98/96/bb47bf36138dce6163e6643cd74ee12d38b2dc9377648bc1f54bb4241eb6/livingdocs-0.1.3.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "4406b0036757842063cfd9ea25da86be", "sha256": "7772c6dde2eea6e5c925c82f046e710c8085f34d839119947843b290d103333c" }, "downloads": -1, "filename": "livingdocs-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4406b0036757842063cfd9ea25da86be", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 228793, "upload_time": "2016-09-17T02:36:21", "url": "https://files.pythonhosted.org/packages/2c/2b/637c5cbeae30addaa76feedded97e1c6f8a761ddf65b78bd9740149c3804/livingdocs-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b3fe6806b7cde21716312f828b37ddbf", "sha256": "54410503b44c514ae2c9dd84143aa54726f679dae9405972acafca99d93ba104" }, "downloads": -1, "filename": "livingdocs-0.2.0.tar.gz", "has_sig": false, "md5_digest": "b3fe6806b7cde21716312f828b37ddbf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 233189, "upload_time": "2016-09-17T02:36:25", "url": "https://files.pythonhosted.org/packages/cc/35/df7137f9fbe76df53d85ab2f007d167d7ea3005b1cc4fd824b6e12074c84/livingdocs-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4406b0036757842063cfd9ea25da86be", "sha256": "7772c6dde2eea6e5c925c82f046e710c8085f34d839119947843b290d103333c" }, "downloads": -1, "filename": "livingdocs-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "4406b0036757842063cfd9ea25da86be", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 228793, "upload_time": "2016-09-17T02:36:21", "url": "https://files.pythonhosted.org/packages/2c/2b/637c5cbeae30addaa76feedded97e1c6f8a761ddf65b78bd9740149c3804/livingdocs-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b3fe6806b7cde21716312f828b37ddbf", "sha256": "54410503b44c514ae2c9dd84143aa54726f679dae9405972acafca99d93ba104" }, "downloads": -1, "filename": "livingdocs-0.2.0.tar.gz", "has_sig": false, "md5_digest": "b3fe6806b7cde21716312f828b37ddbf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 233189, "upload_time": "2016-09-17T02:36:25", "url": "https://files.pythonhosted.org/packages/cc/35/df7137f9fbe76df53d85ab2f007d167d7ea3005b1cc4fd824b6e12074c84/livingdocs-0.2.0.tar.gz" } ] }