{ "info": { "author": "Subhaditya Mukherjee", "author_email": "mukherjeesubhaditya001@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# README\n## Contents\n1. THE README FOR THIS PROGRAM IS ALSO GENERATED BY THE CODE ITSELF.\n\n2. ADDS ARGUMENTS\n\n3. FIND THE SIDE COMMENTS AND CREATE CONTENTS LIST\n\n4. FORMAT THE FILE AND SAVE\n\n5. MAIN FUNCTION\n\n## Docstrings\n>This program converts all the comments in your code to a README.md file and saves a lot of your time provided you write comments in your code. It is obvious how easy it is to actually generate the README.md file and save your time.Using the argparse module to get the file path. Note that to run the file\n```bash\npython -m code2read.code -p -o \n#example\npython -m code2read.code -p \"setup.py\" -o \"/Users/lordvile/Downloads/\"\n```\n>\nFor now this program only supports python.\n## Side comments\n- Initial file\n\n- Output file\n\n**GENERATED README**\n![generatedoutput](output/gen.png)\n**INITIAL CODE**\n![initialcode](output/code.png)\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/SubhadityaMukherjee/code_to_readme", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "code2read", "package_url": "https://pypi.org/project/code2read/", "platform": "", "project_url": "https://pypi.org/project/code2read/", "project_urls": { "Homepage": "https://github.com/SubhadityaMukherjee/code_to_readme" }, "release_url": "https://pypi.org/project/code2read/0.2.2.0/", "requires_dist": null, "requires_python": "", "summary": "Converts your code with comments into a workable README.md: Code more. Write less.", "version": "0.2.2.0" }, "last_serial": 5225672, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "4ac7b72c058ad4f0c24deb1e2a83661b", "sha256": "b83e006f3ebe19f70bb86627b86c012ca1b60cd6b0d462b3c9c8fe09f22f1f84" }, "downloads": -1, "filename": "code2read-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "4ac7b72c058ad4f0c24deb1e2a83661b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2489, "upload_time": "2019-05-04T12:26:00", "url": "https://files.pythonhosted.org/packages/81/8f/7694cfcb5d04b6b9f001088efc2a449659efea927f4dbe99301a2511c038/code2read-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8295f75905f5272162b047747fe783f2", "sha256": "851aea0e37d19b868b60c7c203a7cb0fb8e4ad5adfefa20c6243616edf6446e5" }, "downloads": -1, "filename": "code2read-0.1.tar.gz", "has_sig": false, "md5_digest": "8295f75905f5272162b047747fe783f2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1948, "upload_time": "2019-05-04T12:26:02", "url": "https://files.pythonhosted.org/packages/18/82/6cdca46fd0a525419618601734c0798a621744f598e5eb01e9bf82871bef/code2read-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "bc34504fdd38452769bb0f94f7cf349e", "sha256": "213eda54976ed4a411808fe00fc2269ee2fec238890235debd8595e84b48fc99" }, "downloads": -1, "filename": "code2read-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "bc34504fdd38452769bb0f94f7cf349e", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2458, "upload_time": "2019-05-04T12:33:28", "url": "https://files.pythonhosted.org/packages/fc/97/cbac03ad6014a197964ef83189e4b2f32828b7aadb0947b738c28b1d9e80/code2read-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cca0dd1b0f864d44cca56f8a6d7098a6", "sha256": "c4c4a74ee71326d81427ef39c6d371566b3134beeeaf9288624c3da0ac3315d8" }, "downloads": -1, "filename": "code2read-0.2.tar.gz", "has_sig": false, "md5_digest": "cca0dd1b0f864d44cca56f8a6d7098a6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1925, "upload_time": "2019-05-04T12:33:29", "url": "https://files.pythonhosted.org/packages/08/99/993e8c33bd710e67f77faa493220bd0498aeaff98236aecd92f3d2757475/code2read-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "af2058e9d3bb13238097e672306d84eb", "sha256": "a1c05ac6ba4fc25a28dc9e1c28cc987d7eb59f7255d889000c3d95c1cb4c050d" }, "downloads": -1, "filename": "code2read-0.2.1-py3-none-any.whl", "has_sig": false, "md5_digest": "af2058e9d3bb13238097e672306d84eb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3505, "upload_time": "2019-05-04T12:38:26", "url": "https://files.pythonhosted.org/packages/ba/1e/c6f9ac60367474c7796b674281f9662e37e029418f0c5e951868a95b6c34/code2read-0.2.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4eab34d4d9e6759939a3331639627ad7", "sha256": "f35439527cbd1c2152bd0319cbed4ad8431370f6026e3dcacd1c7e97e50f81a6" }, "downloads": -1, "filename": "code2read-0.2.1.tar.gz", "has_sig": false, "md5_digest": "4eab34d4d9e6759939a3331639627ad7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1982, "upload_time": "2019-05-04T12:38:27", "url": "https://files.pythonhosted.org/packages/17/09/8ec63dee9826fcd64064ac063d90b13538d4d448f8ff18a3036be76b90c9/code2read-0.2.1.tar.gz" } ], "0.2.1.1": [ { "comment_text": "", "digests": { "md5": "bede4c6e8e7f15cc5f15be9e1bbb9f69", "sha256": "73881124357f5ab93e7b9eb6eeb2cbd8b67d090a327b22f4783e6296ebfbb639" }, "downloads": -1, "filename": "code2read-0.2.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "bede4c6e8e7f15cc5f15be9e1bbb9f69", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2574, "upload_time": "2019-05-04T12:44:45", "url": "https://files.pythonhosted.org/packages/b8/ae/8ed2796925967e77b59aa749dfbbff2599b4ecb2422870173a0d1e8280d0/code2read-0.2.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2e876280f57c4d58c79295f0af24580d", "sha256": "d49b37d56205da25997ddc88f86dc34e6f9c8f32fd166eb575049972ed0a67f1" }, "downloads": -1, "filename": "code2read-0.2.1.1.tar.gz", "has_sig": false, "md5_digest": "2e876280f57c4d58c79295f0af24580d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1970, "upload_time": "2019-05-04T12:44:46", "url": "https://files.pythonhosted.org/packages/4a/86/a6c4262c46cc3d4e71a9bc5c793424af3ec9f9448064bfbfe37b9d06ce78/code2read-0.2.1.1.tar.gz" } ], "0.2.1.2": [ { "comment_text": "", "digests": { "md5": "ee2b5217ff8b77fb6c355ca3ddc9d5f9", "sha256": "0f996255c56950f20077034de7580ef03ca89891aca83c4f1ffff36abe972494" }, "downloads": -1, "filename": "code2read-0.2.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "ee2b5217ff8b77fb6c355ca3ddc9d5f9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2835, "upload_time": "2019-05-04T12:49:41", "url": "https://files.pythonhosted.org/packages/83/08/3ef991dc487605e0a52f2475f3bb7623ed3e06bc32f11cf772a0814e9c00/code2read-0.2.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c6ea9b801b133a3092b4fa4ac9f4adf0", "sha256": "4568d73a004270a8cfcd617a4cc5592328a4dfde4a48987a1cc7b933cf75b985" }, "downloads": -1, "filename": "code2read-0.2.1.2.tar.gz", "has_sig": false, "md5_digest": "c6ea9b801b133a3092b4fa4ac9f4adf0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2057, "upload_time": "2019-05-04T12:49:42", "url": "https://files.pythonhosted.org/packages/d6/88/26e14188d47ce49107b3d960bdd37c174b839880b0eecf2ca52f340ec9b0/code2read-0.2.1.2.tar.gz" } ], "0.2.1.3": [ { "comment_text": "", "digests": { "md5": "79b9a84fe68d9213e6bb2ab460622cd1", "sha256": "0950eae90984c783629acc50c0f91257a8662747e9eecd6dc0aa2e0fa24a38b9" }, "downloads": -1, "filename": "code2read-0.2.1.3-py3-none-any.whl", "has_sig": false, "md5_digest": "79b9a84fe68d9213e6bb2ab460622cd1", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2848, "upload_time": "2019-05-04T12:51:46", "url": "https://files.pythonhosted.org/packages/e3/b0/a8af7162611b9ab82dba306b831c8ff3cf057a11a140b731c9f0ccdf9a85/code2read-0.2.1.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f8bbf9e2d9acf7afcc089f968e20fe5f", "sha256": "8b5422a293268f3054857dc24a3797f8d23052c74c66b4beda147c2162f8b475" }, "downloads": -1, "filename": "code2read-0.2.1.3.tar.gz", "has_sig": false, "md5_digest": "f8bbf9e2d9acf7afcc089f968e20fe5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2068, "upload_time": "2019-05-04T12:51:47", "url": "https://files.pythonhosted.org/packages/dc/2c/dd0ffe4d7dfe4c999a6f4ee6a1e530e058e4194b9182ed90b8e6c699d443/code2read-0.2.1.3.tar.gz" } ], "0.2.1.7": [ { "comment_text": "", "digests": { "md5": "c28f9caf41567574f5df2d09135b7767", "sha256": "af08dcfcaf1e6d949e5dd1ed5c1b0e048bb477e657f3ab00d640eed8892934ee" }, "downloads": -1, "filename": "code2read-0.2.1.7.tar.gz", "has_sig": false, "md5_digest": "c28f9caf41567574f5df2d09135b7767", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2164, "upload_time": "2019-05-04T13:42:24", "url": "https://files.pythonhosted.org/packages/01/57/cae5e298cec5374e05ee7d2e598b9671f1a9891d5234a2e4b92178568366/code2read-0.2.1.7.tar.gz" } ], "0.2.1.8": [ { "comment_text": "", "digests": { "md5": "d084bbe5281fcdd734ef0dd79d4746da", "sha256": "1f9df94dbd92535e5831f309a722c43c262195d3a4b9148f730bc5848e0ed98c" }, "downloads": -1, "filename": "code2read-0.2.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "d084bbe5281fcdd734ef0dd79d4746da", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3485, "upload_time": "2019-05-04T14:07:00", "url": "https://files.pythonhosted.org/packages/98/43/4e36818cc7dce375a226a3a19b058742a0699f8e1200e90592613e097267/code2read-0.2.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a37bb03912c974aea7cec6aacc59ce70", "sha256": "f33361cb43be63730f2f43083cbf040c8dec6e50e593265f6253d596dd0777ab" }, "downloads": -1, "filename": "code2read-0.2.1.8.tar.gz", "has_sig": false, "md5_digest": "a37bb03912c974aea7cec6aacc59ce70", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2171, "upload_time": "2019-05-04T13:42:26", "url": "https://files.pythonhosted.org/packages/f5/07/41fda6b0bce4339896c2b94d75b87cf66fa2c153d0338595cf082bc5b5ee/code2read-0.2.1.8.tar.gz" } ], "0.2.2.0": [ { "comment_text": "", "digests": { "md5": "4d098d746f1fee30880b1bb86bfdfc29", "sha256": "2b94d0b846345a9dab5c6a4c3eaf2d12addae4ba5456bdd00c3fa087eef7584e" }, "downloads": -1, "filename": "code2read-0.2.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4d098d746f1fee30880b1bb86bfdfc29", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3485, "upload_time": "2019-05-04T14:07:01", "url": "https://files.pythonhosted.org/packages/87/99/936fb36996c3bfb9a4c4ae90f75220b3c2e2fa3b2cd20a01e5d752206c4b/code2read-0.2.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c23972da3544e33a2681870ac755d91f", "sha256": "b89c326c7143fc07ba736359d8143b412f1bb1051d0202ef8d6df25652073ab4" }, "downloads": -1, "filename": "code2read-0.2.2.0.tar.gz", "has_sig": false, "md5_digest": "c23972da3544e33a2681870ac755d91f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2582, "upload_time": "2019-05-04T14:07:03", "url": "https://files.pythonhosted.org/packages/f3/eb/706f1bf1e3551fc5d904a72ee3e5b93a4f7692025c7e0618c26a6166606b/code2read-0.2.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4d098d746f1fee30880b1bb86bfdfc29", "sha256": "2b94d0b846345a9dab5c6a4c3eaf2d12addae4ba5456bdd00c3fa087eef7584e" }, "downloads": -1, "filename": "code2read-0.2.2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "4d098d746f1fee30880b1bb86bfdfc29", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3485, "upload_time": "2019-05-04T14:07:01", "url": "https://files.pythonhosted.org/packages/87/99/936fb36996c3bfb9a4c4ae90f75220b3c2e2fa3b2cd20a01e5d752206c4b/code2read-0.2.2.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c23972da3544e33a2681870ac755d91f", "sha256": "b89c326c7143fc07ba736359d8143b412f1bb1051d0202ef8d6df25652073ab4" }, "downloads": -1, "filename": "code2read-0.2.2.0.tar.gz", "has_sig": false, "md5_digest": "c23972da3544e33a2681870ac755d91f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2582, "upload_time": "2019-05-04T14:07:03", "url": "https://files.pythonhosted.org/packages/f3/eb/706f1bf1e3551fc5d904a72ee3e5b93a4f7692025c7e0618c26a6166606b/code2read-0.2.2.0.tar.gz" } ] }