{ "info": { "author": "The Renegade Coder", "author_email": "jeremy.grifski@therenegadecoder.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# The Sample Programs Wiki Generator\n\n[![Join the chat at https://gitter.im/TheRenegadeCoder/sample-programs-wiki-generator](https://badges.gitter.im/TheRenegadeCoder/sample-programs-wiki-generator.svg)](https://gitter.im/TheRenegadeCoder/sample-programs-wiki-generator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\nCurrently, the Sample Programs Wiki Generator repo houses the `generate-wiki.py` script which\nwe use in the Sample Programs repository to generate our wiki documentation. The script\nis automated by a Travis CI build in the Sample Programs repo.\n\nIf you would like to propose a change, feel free to leverage the issues tab or make a pull request.\n\n## How It Works\n\nThe `generate_wiki.py` script works by analyzing the information in the Sample Programs\nrepository and storing that information in objects. These objects are then used to\ngenerate various wiki pages in Markdown. \n\n## What is Automated\n\nCurrently, the script generates 27 pages: 1 alphabet catalog and 26 alphabet pages. \n\nThe alphabet catalog contains a table with links to each alphabet page as well as meta data like the number\nof scripts and languages per letter. In addition, the alphabet catalog contains the total number of scripts\nand languages for the entire repo. \n\nEach alphabet page contains a table which lists each language for that particular letter as well as meta data\nlike the number of scripts per language and links to articles and issues.\n\n## How to Run\n\nAt this time, the wiki generator is hardcoded for the Sample Programs repo. In order to run it, \nyou can install it as a package using `pip`:\n\n`pip install generate_wiki`\n\nAfter that, you'll need a copy of the Sample Programs repo:\n\n`git clone https://github.com/TheRenegadeCoder/sample-programs.git`\n\nFinally, you can build the wiki using the following command:\n\n`wikig /path/to/sample-programs/repo/archive`\n\nAlternatively, you can clone this repo to run the `generate_wiki.py` script directly:\n\n`python generate-wiki.py /path/to/sample-programs/repo/archive`\n\nBoth solutions are designed to handle repo exploration from the `/archive/` directory. If successful, you should\nbegin to see print statements for the various links under test for The Renegade Coder. When finished, you'll\nhave a `/wiki/` directory next to your script which contains the wiki.\n\nAt this point, you can push the wiki directly to the Sample Programs wiki.", "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/TheRenegadeCoder/sample-programs-wiki-generator", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "generate-wiki", "package_url": "https://pypi.org/project/generate-wiki/", "platform": "", "project_url": "https://pypi.org/project/generate-wiki/", "project_urls": { "Homepage": "https://github.com/TheRenegadeCoder/sample-programs-wiki-generator" }, "release_url": "https://pypi.org/project/generate-wiki/1.1.1/", "requires_dist": null, "requires_python": "", "summary": "A wiki generation package for the Sample Programs repo", "version": "1.1.1" }, "last_serial": 5008010, "releases": { "1.0.1": [ { "comment_text": "", "digests": { "md5": "2acb826842d5cc4d063272ce05372fc7", "sha256": "e03339f4ec45aa4c0bab1070625755187897c68db9ffb4b89531096ab02d1b72" }, "downloads": -1, "filename": "generate_wiki-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2acb826842d5cc4d063272ce05372fc7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4764, "upload_time": "2018-08-11T15:59:28", "url": "https://files.pythonhosted.org/packages/bf/6d/98deb1b9455f943db855db0307863de0b0c40ac2b0f4fdcc46f48ee5a864/generate_wiki-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "924c55f6c919e07db4de72fc59a0e98b", "sha256": "e0cc4e226cb80501be53ece3ceb7a079e928ea761fd63b28755381fe89374dc6" }, "downloads": -1, "filename": "generate_wiki-1.0.1.tar.gz", "has_sig": false, "md5_digest": "924c55f6c919e07db4de72fc59a0e98b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4123, "upload_time": "2018-08-11T15:59:29", "url": "https://files.pythonhosted.org/packages/06/e9/a29cccf2ee32ed4d75d3acc83a538328333463fcd0db65cb1586ab61bc6e/generate_wiki-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "14f5159925d98cc9d2168f4d81cbe281", "sha256": "f8cfce66e62793c1e92bb545bfcfd268e1fd2baac64705307d2680eeb3ae91d8" }, "downloads": -1, "filename": "generate_wiki-1.0.2.tar.gz", "has_sig": false, "md5_digest": "14f5159925d98cc9d2168f4d81cbe281", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4181, "upload_time": "2018-08-12T04:20:21", "url": "https://files.pythonhosted.org/packages/8b/d4/31fbf3d4e1f083da8ebfa3239049edc139cacf6282e5883451a2cf353558/generate_wiki-1.0.2.tar.gz" } ], "1.0.3": [ { "comment_text": "", "digests": { "md5": "0065353bfa876cc4502f81cf04f37210", "sha256": "e94d7911fdd3de1d6e69ea152d6302c1d963ce972c10475cf2e1572e7a89572b" }, "downloads": -1, "filename": "generate_wiki-1.0.3.tar.gz", "has_sig": false, "md5_digest": "0065353bfa876cc4502f81cf04f37210", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4349, "upload_time": "2018-10-05T03:12:54", "url": "https://files.pythonhosted.org/packages/c4/2d/bff7965fb0b140d631934f0127651633146b54e2f3719b34698068d05193/generate_wiki-1.0.3.tar.gz" } ], "1.0.4": [ { "comment_text": "", "digests": { "md5": "da8b84869b5841bcbb9d27c02c767923", "sha256": "4ebe751c432f4bfa985b31725911a7f6ed2a024595da4d284e29dae32a30dd69" }, "downloads": -1, "filename": "generate_wiki-1.0.4.tar.gz", "has_sig": false, "md5_digest": "da8b84869b5841bcbb9d27c02c767923", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4348, "upload_time": "2019-01-02T15:44:01", "url": "https://files.pythonhosted.org/packages/ec/e3/1fc45436ba064781e3cc8cedbedbb62e5260c0f58fc1e1d1d2f5b0f8c71d/generate_wiki-1.0.4.tar.gz" } ], "1.0.5": [ { "comment_text": "", "digests": { "md5": "736ae828a279150890203419fa07dc86", "sha256": "02b10291b4b87871e4fdc258d4c688bb098760f0d14a343ab038ef7652b2b96e" }, "downloads": -1, "filename": "generate_wiki-1.0.5.tar.gz", "has_sig": false, "md5_digest": "736ae828a279150890203419fa07dc86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4358, "upload_time": "2019-01-02T15:59:29", "url": "https://files.pythonhosted.org/packages/c9/f8/2c358f5c3caf1c80adc50375d7e9f694b4b1a070034a638486de050c3d56/generate_wiki-1.0.5.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "68f2de62c23180172c1b31256e9be167", "sha256": "82c794c66aa7113965411e2e7ca2809ff7da776ff982d043fcff311184038f9b" }, "downloads": -1, "filename": "generate_wiki-1.1.0.tar.gz", "has_sig": false, "md5_digest": "68f2de62c23180172c1b31256e9be167", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4516, "upload_time": "2019-03-28T19:05:13", "url": "https://files.pythonhosted.org/packages/0c/49/5d35ad9245e8e1316c83317c2aedcfe98408329e31e08ae7bf557952588c/generate_wiki-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "0b773d40cdbedcc00c068b06ee562574", "sha256": "bdeb385fbe4f67444b61828b5d69fd0b422b3b6b5138c1a05520fd299bfef937" }, "downloads": -1, "filename": "generate_wiki-1.1.1.tar.gz", "has_sig": false, "md5_digest": "0b773d40cdbedcc00c068b06ee562574", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4519, "upload_time": "2019-03-30T21:52:23", "url": "https://files.pythonhosted.org/packages/df/1c/f18de27f7e03103240328cc3d9f69b4ab4e8005796fa4b94dc43de387948/generate_wiki-1.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0b773d40cdbedcc00c068b06ee562574", "sha256": "bdeb385fbe4f67444b61828b5d69fd0b422b3b6b5138c1a05520fd299bfef937" }, "downloads": -1, "filename": "generate_wiki-1.1.1.tar.gz", "has_sig": false, "md5_digest": "0b773d40cdbedcc00c068b06ee562574", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4519, "upload_time": "2019-03-30T21:52:23", "url": "https://files.pythonhosted.org/packages/df/1c/f18de27f7e03103240328cc3d9f69b4ab4e8005796fa4b94dc43de387948/generate_wiki-1.1.1.tar.gz" } ] }