{
    "info": {
        "author": "Nilan Saha",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Programming Language :: Python"
        ],
        "description": "# MD Generator (mdgenerator)\n\nmdgenerator is a package to generate different kinds of markdown texts\n\nFollowing details the functionality provided by the package:\n\n- Generate File Structure Trees in Markdown\n- Generate Tables in Markdown from pandas dataframe or python arrays\n\n## Installation\n\nThere are two ways to install mdgenerator:\n\n- Install mdgenerator from PyPI (recommended):\n\n```\npip install mdgenerator\n```\n\n- Install mdgenerator from the Github source:\n\n```\ngit clone https://github.com/nilansaha/mdgenerator.git\ncd mdgenerator\npip install .\n```\n\n## Usage\n\n- Generate File Tree Structure in Markdown\n\n\t- Using Python\n\n\n\t```\n\tfrom mdgenerator import generate_file_structure\n\n\tgenerate_file_structure(target_dir='/path/to/directory', output_dir='/output/directory')\n\t```\n\n\t- Using the terminal\n\n\n\t```\n\tmdgenerator --target_dir \"/path/to/directory\" --output_dir \"/output/directory\"\n\t```\n\n\t**Output** is stored in `file_structure.md` in the specified `output_dir`\n\n\tSample Output - \n\n\t```\n\t\u251c\u2500\u2500 .DS_Store\n\t\u251c\u2500\u2500 mdgenerator.py\n\t\u251c\u2500\u2500 __init__.py\n\t\u251c\u2500\u2500 test.py\n\t\u251c\u2500\u2500 cli.py\n\t\u251c\u2500\u2500 file-structure.md\n\t\u251c\u2500\u2500 ABC\n\t|   \u251c\u2500\u2500 a.txt\n\t|   \u251c\u2500\u2500 BCD\n\t|   |   \u251c\u2500\u2500 b.txt\n\t\u251c\u2500\u2500 __pycache__\n\t|   \u251c\u2500\u2500 mdgenerator.cpython-37.pyc\n\t```\n\n- Generate Markdown Table using Python\n\n\t- Using Python lists\n\n\t```\n\tfrom mdgenerator import generate_table\n\n\tdata = [['Word_1','Word_2'],['Happy','Sad'],['Nice','Bad']]\n\ttable = generate_table(data)\n\tprint(table)\n\t```\n\t**Output**\n\n\t|Word_1|Word_2|\n\t|---|---|\n\t|Happy|Sad|\n\t|Nice|Bad|\n\n\n\t- Using Pandas DataFrame\n\n\t```\n\timport pandas as pd\n\tfrom mdgenerator import generate_table\n\n\tdf = pd.DataFrame([['Happy','Sad'], ['Nice','Bad']], columns = ['Word_1','Word_2'])\n\ttable = generate_table(df)\n\tprint(table)\n\t```\n\t**Output**\n\n\t|Word_1|Word_2|\n\t|---|---|\n\t|Happy|Sad|\n\t|Nice|Bad|\n\n\n\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/nilansaha/mdgenerator",
        "keywords": "",
        "license": "Apache 2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "mdgenerator",
        "package_url": "https://pypi.org/project/mdgenerator/",
        "platform": "",
        "project_url": "https://pypi.org/project/mdgenerator/",
        "project_urls": {
            "Homepage": "https://github.com/nilansaha/mdgenerator"
        },
        "release_url": "https://pypi.org/project/mdgenerator/0.1.0/",
        "requires_dist": [
            "numpy (==1.16.2)",
            "pandas (==0.24.2)"
        ],
        "requires_python": ">=3.6",
        "summary": "Package to generate different kind of markdown texts",
        "version": "0.1.0"
    },
    "last_serial": 5969222,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "66ea307b81778adcf85a5bda99faa047",
                    "sha256": "db13f67a42746d01af4b4d7a90033095f58559dc1c0db897bc8954c0ddcc9dfc"
                },
                "downloads": -1,
                "filename": "mdgenerator-0.1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "66ea307b81778adcf85a5bda99faa047",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": ">=3.6",
                "size": 7590,
                "upload_time": "2019-10-13T23:56:29",
                "url": "https://files.pythonhosted.org/packages/21/93/8eff4803a352058726d00bd19731c6d99d765b873eb50b8312e0b6d672d9/mdgenerator-0.1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "e09c6fd915965ef203ad52669c40ccb7",
                    "sha256": "079b90657329c66b0e6bec9180fb19c637762e8f87c472f6939713da69362971"
                },
                "downloads": -1,
                "filename": "mdgenerator-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "e09c6fd915965ef203ad52669c40ccb7",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 2709,
                "upload_time": "2019-10-13T23:56:32",
                "url": "https://files.pythonhosted.org/packages/b9/25/287e56ffc7dfb1c6cabf4508d9b966156a4a7f5fea455d997b9bb184b2fa/mdgenerator-0.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "66ea307b81778adcf85a5bda99faa047",
                "sha256": "db13f67a42746d01af4b4d7a90033095f58559dc1c0db897bc8954c0ddcc9dfc"
            },
            "downloads": -1,
            "filename": "mdgenerator-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "66ea307b81778adcf85a5bda99faa047",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 7590,
            "upload_time": "2019-10-13T23:56:29",
            "url": "https://files.pythonhosted.org/packages/21/93/8eff4803a352058726d00bd19731c6d99d765b873eb50b8312e0b6d672d9/mdgenerator-0.1.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "e09c6fd915965ef203ad52669c40ccb7",
                "sha256": "079b90657329c66b0e6bec9180fb19c637762e8f87c472f6939713da69362971"
            },
            "downloads": -1,
            "filename": "mdgenerator-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e09c6fd915965ef203ad52669c40ccb7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 2709,
            "upload_time": "2019-10-13T23:56:32",
            "url": "https://files.pythonhosted.org/packages/b9/25/287e56ffc7dfb1c6cabf4508d9b966156a4a7f5fea455d997b9bb184b2fa/mdgenerator-0.1.0.tar.gz"
        }
    ]
}