{ "info": { "author": "Enrique Henestroza Anguiano", "author_email": "ehenestroza@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8" ], "description": "# Twine Graph\n\nTwine Graph is a Python package and command line tool for parsing passage and link structure\nfrom published .html Twine stories and outputting the resulting graphs in visual (.pdf) or\nstructured (.json) formats. The goal of Twine Graph is to allow for research and analysis of\nstory structure in freely-available Twine games.\n\n### Prerequisites\n\nTwine Graph requires Python 3 and the `beautifulsoup4` and `graphviz` packages. Tested primarily\non Mac OS X within an Anaconda environment.\n\n### Installation\n\nThe easiest way to install Twine Graph is through `pip`:\n\n```\npip install twine-graph\n```\n\n### Example usage\n\nThe installed package can be called from the command line through its entry-point, as in the \nfollowing sample call (using the example .html file included in the github project):\n\n```\ntwine_graph twine_graph_example.html\n```\n\nThe output .gv.pdf file can be opened for a visual representation of the passage and link structure\nof the story, while the output .json file provides a structured representation:\n\n```\n{\n \"passages\": [\n {\n \"pid\": 1,\n \"name\": \"Hello\",\n \"text\": \"[[Hello->World]]\",\n \"links\": [\n {\n \"text\": \"Hello\",\n \"destination\": {\n \"name\": \"World\",\n \"pid\": 2\n }\n }\n ]\n },\n {\n \"pid\": 2,\n \"name\": \"World\",\n \"text\": \"Hello World\",\n \"links\": []\n }\n ]\n}\n```\n\n### Known Issues\n\n- Doesn't detect links produced by custom javascript\n- Doesn't detect links referenced through variables (i.e. variable tracking not supported)\n\n### Related Work\n\n- [twine-parser](https://github.com/unwitting/twine-parser): A Javascript utility for parsing \ntwine stories into graph objects.\n- [TwineJson](https://github.com/cauli/TwineJson): A utility for Twine that exports a story\ninto JSON format.\n\n### Author\n\nEnrique Henestroza Anguiano\n- Website: [Datalexic](datalexic.com)\n\n### License\n\nThis project is licensed under the GNU GPL License - see [LICENSE](LICENSE) for details\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ehenestroza/twine-graph", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "twine-graph", "package_url": "https://pypi.org/project/twine-graph/", "platform": "", "project_url": "https://pypi.org/project/twine-graph/", "project_urls": { "Homepage": "https://github.com/ehenestroza/twine-graph" }, "release_url": "https://pypi.org/project/twine-graph/0.0.1/", "requires_dist": [ "beautifulsoup4", "graphviz" ], "requires_python": "", "summary": "A utility for parsing HTML Twine stories and saving them into json or graph formats", "version": "0.0.1" }, "last_serial": 4598236, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "9166d8fb1c3f9b5e87a168fcaa842128", "sha256": "f49f955a4afdaa1e3b7ce9e56583007daae79dc58076e36b87f601e488a8c694" }, "downloads": -1, "filename": "twine_graph-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9166d8fb1c3f9b5e87a168fcaa842128", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5857, "upload_time": "2018-12-14T07:04:05", "url": "https://files.pythonhosted.org/packages/27/bf/03e79eab7b9da5e57f05e6cac11be0a15e3a02792ae9c105bd63f3600a0b/twine_graph-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "38091dcd534a4d0dd671f2a1e6b35f92", "sha256": "50cb8d33ab353ae04eb4bbdd4dbb489f1154d97cdc0e40efe0257992d72fb25a" }, "downloads": -1, "filename": "twine-graph-0.0.1.tar.gz", "has_sig": false, "md5_digest": "38091dcd534a4d0dd671f2a1e6b35f92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5157, "upload_time": "2018-12-14T07:04:07", "url": "https://files.pythonhosted.org/packages/c5/1b/3d0a6403e9e796dff66a31b47999b552755a218061459e0f8159992e219e/twine-graph-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9166d8fb1c3f9b5e87a168fcaa842128", "sha256": "f49f955a4afdaa1e3b7ce9e56583007daae79dc58076e36b87f601e488a8c694" }, "downloads": -1, "filename": "twine_graph-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "9166d8fb1c3f9b5e87a168fcaa842128", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5857, "upload_time": "2018-12-14T07:04:05", "url": "https://files.pythonhosted.org/packages/27/bf/03e79eab7b9da5e57f05e6cac11be0a15e3a02792ae9c105bd63f3600a0b/twine_graph-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "38091dcd534a4d0dd671f2a1e6b35f92", "sha256": "50cb8d33ab353ae04eb4bbdd4dbb489f1154d97cdc0e40efe0257992d72fb25a" }, "downloads": -1, "filename": "twine-graph-0.0.1.tar.gz", "has_sig": false, "md5_digest": "38091dcd534a4d0dd671f2a1e6b35f92", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5157, "upload_time": "2018-12-14T07:04:07", "url": "https://files.pythonhosted.org/packages/c5/1b/3d0a6403e9e796dff66a31b47999b552755a218061459e0f8159992e219e/twine-graph-0.0.1.tar.gz" } ] }