{ "info": { "author": "dli", "author_email": "286264978@qq.com", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "Intended Audience :: System Administrators", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "======\nReadMe\n======\n\n\nInstallation\n------------\n ::\n \n $ pip3 install minidoc\n\n\nLicense\n-------\n\n- MIT\n\n\n\nQuickstart\n----------\n- *pip3 install minidoc*\n\n- *make a workdir, such as \"TEST\"*\n \n ::\n \n mkdir TEST\n cd TEST\n \n- *edit your code.tst.py as below:*\n\n ::\n \n cat code.tst.py\n \n\n.. image:: /docs/images/code.tst.py.00.png\n\n- \n\n| *run cmd* **minidoc** ,\n| *will auto exec the code in code.tst.py,* \n| *and auto save the terminal screen-shot(or recording)* \n| *and auto generate a .rst doc-file* \n \n ::\n \n minidoc\n tree\n TEST# tree\n .\n \u251c\u2500\u2500 code.tst.py\n \u251c\u2500\u2500 images------------------------------->generated svgs\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 __getitem__.svg\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 __init__.svg\n \u2514\u2500\u2500 Usage.rst---------------------------->generated .rst\n \n 1 directory, 4 files\n TEST#\n\n \n.. image:: /docs/images/code.tst.py.11.png\n.. image:: /docs/images/code.tst.py.2.png\n\n\n\n- *open generated .rst to check it*\n\n.. image:: /docs/images/code.tst.py.3.png\n\n\n- *minidoc -h*\n\n ::\n \n TEST# minidoc -h\n usage: minidoc [-h] [-tst TEST_FILE] [-codec CODEC] [-still STILL_FRAMES]\n [-rows ROWNUMS] [-dst DST_DIR] [-title TITLE] [-tbot TITLE_BOT]\n [-ebot ENTRY_BOT]\n \n optional arguments:\n -h, --help show this help message and exit\n -tst TEST_FILE, --test_file TEST_FILE .tst.py file name,default = \"code.tst.py\"\n -codec CODEC, --codec CODEC .tst.py file codec,default = \"utf-8\"\n -still STILL_FRAMES, --still_frames STILL_FRAMES generate screen shot,default = True (which means still image but not recording)\n -rows ROWNUMS, --rownums ROWNUMS screen height,default = 30\n -dst DST_DIR, --dst_dir DST_DIR destination svg dir, default =\"./images\"\n -title TITLE, --title TITLE parent title, default = \"Usage\"\n -tbot TITLE_BOT, --title_bot TITLE_BOT parent title bottom char, default = '='\n -ebot ENTRY_BOT, --entry_bot ENTRY_BOT entry title bottom char, default = '-'\n\n\nUsage\n-----\n\n- from code\n\n ::\n \n In progressing.....\n \n\n- from cmdline\n\n ::\n \n # screen shot\n root@# minidoc -tst code.rst.py -dst ./images\n \n # screen recording\n root@# minidoc -tst code.rst.py -dst ./images -still false \n \n # on current dir,screen shot\n root@# minidoc -still true\n \n # on current dir,screen recording\n root@# minidoc -still false\n\n\n- from docstring only one level(experimental,no recursive support, since only one level AST walked)\n \n ::\n \n root@# minidoc_from_docstring -proj dtable\n\n\n\n\nFeatures\n--------\n\n- auto generate .rst doc from .tst.py\n- auto exec test-code in .tst.py \n- auto record the screen and save as .svg\n\n\nRestrict\n--------\n\n- currently only support python3\n\nTODO\n----\n\n- javascript\n- lua\n- tclsh\n\n\nReferences\n----------\n\n* termtosvg\n* elist\n* efdir\n* estring", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ihgazni2/minidoc", "keywords": "doc,test,svg", "license": "MIT license", "maintainer": "", "maintainer_email": "", "name": "minidoc", "package_url": "https://pypi.org/project/minidoc/", "platform": "", "project_url": "https://pypi.org/project/minidoc/", "project_urls": { "Homepage": "https://github.com/ihgazni2/minidoc" }, "release_url": "https://pypi.org/project/minidoc/0.0.4/", "requires_dist": null, "requires_python": "", "summary": "auto generate a mini rst doc (code block + svg) from a test-file", "version": "0.0.4" }, "last_serial": 5877106, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "7f261ee22c51e8a80e25cbca1094d290", "sha256": "675d32330e33491101c8abc03ba78beb5860db2a1cfdca67210f2ac673ea7f3d" }, "downloads": -1, "filename": "minidoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "7f261ee22c51e8a80e25cbca1094d290", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6232, "upload_time": "2019-02-16T16:02:57", "url": "https://files.pythonhosted.org/packages/43/41/7eb2bdd359d3bd6fad1c877dcc2946d1e010df6f32167d343e13bc1914f7/minidoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "690805dc9ff5994d125031aadc95a306", "sha256": "472e37a511cdc15dddc018b006fe55545aed12a0a6ef193e4613942933a481c1" }, "downloads": -1, "filename": "minidoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "690805dc9ff5994d125031aadc95a306", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6245, "upload_time": "2019-08-14T08:09:25", "url": "https://files.pythonhosted.org/packages/93/8a/3541eff4d560e0e6e974cd847a6fbee5c3a426f69ac0dff31964c7d02a05/minidoc-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "ce13a8f0f32bbdcfa847f0d896e1c944", "sha256": "df9d6eac8e4a105ea0d972ca7c54beaa96f967fcc4cde84d105876ea4145162e" }, "downloads": -1, "filename": "minidoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "ce13a8f0f32bbdcfa847f0d896e1c944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7534, "upload_time": "2019-09-24T02:26:44", "url": "https://files.pythonhosted.org/packages/dd/b5/9d0e845af71b1af88f3fbda9f355cf7ba609432e3b46be62721b0100dc21/minidoc-0.0.4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ce13a8f0f32bbdcfa847f0d896e1c944", "sha256": "df9d6eac8e4a105ea0d972ca7c54beaa96f967fcc4cde84d105876ea4145162e" }, "downloads": -1, "filename": "minidoc-0.0.4.tar.gz", "has_sig": false, "md5_digest": "ce13a8f0f32bbdcfa847f0d896e1c944", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7534, "upload_time": "2019-09-24T02:26:44", "url": "https://files.pythonhosted.org/packages/dd/b5/9d0e845af71b1af88f3fbda9f355cf7ba609432e3b46be62721b0100dc21/minidoc-0.0.4.tar.gz" } ] }