{ "info": { "author": "Pavel H\u00fcbner", "author_email": "pavel.hubner@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Utilities" ], "description": "# mdcat - Markdown-friendly variant of cat\n\nEver struggling quickly documenting your server configuration files in a Git repo or sharing them with your colleagues for the future reference? Welcome to **mdcat**.\n\nIt is a simple Python 3 command line utility, ingesting file path(s) arguments, and printing their content in Markdown-friendly format.\n\nMoreover, it prints the file's absolute path, mode (permissions), and owner (user + group).\n\n## Requirements\n\n* Python3 + PIP\n\n## Installation\n\nInstall/upgrade the tool from PyPI using:\n\n $ pip3 install --upgrade mdcat\n\n## Usage\n\n $ mdcat --help\n Usage: mdcat [OPTIONS] [FILES]...\n\n Options:\n --version Show the version and exit.\n --help Show this message and exit.\n\nExample:\n\n $ echo foo >> bar\n $ mdcat bar\n\nOutput:\n\n File: `/home/pavel/mdcat/bar` (`0644 pavel:users`):\n\n foo\n\n## Contributing\n\nPlease read [**CONTRIBUTING.md**](https://github.com/hubpav/mdcat/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nWe use [**SemVer**](https://semver.org/) for versioning. For the versions available, see the [**tags on this repository**](https://github.com/hubpav/mdcat/tags).\n\n## Authors\n\n* [**Pavel H\u00fcbner**](https://github.com/hubpav) - Initial work\n\n## License\n\nThis project is licensed under the [**MIT License**](https://opensource.org/licenses/MIT/) - see the [**LICENSE**](https://github.com/hubpav/mdcat/blob/master/LICENSE) file 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/hubpav/mdcat", "keywords": "markdown cat dump file", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "mdcat", "package_url": "https://pypi.org/project/mdcat/", "platform": "any", "project_url": "https://pypi.org/project/mdcat/", "project_urls": { "Homepage": "https://github.com/hubpav/mdcat" }, "release_url": "https://pypi.org/project/mdcat/1.0.0/", "requires_dist": [ "click (==7.0)" ], "requires_python": "", "summary": "Markdown-friendly variant of cat", "version": "1.0.0" }, "last_serial": 5140523, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "eb487125f5a479f0ea0e9d22903426b4", "sha256": "0e4cabdadd9b62232b7560f958e4a9572fd7aab2f1a8583dd42449efe26c4e63" }, "downloads": -1, "filename": "mdcat-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eb487125f5a479f0ea0e9d22903426b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3830, "upload_time": "2019-04-14T10:58:57", "url": "https://files.pythonhosted.org/packages/20/16/262a03cde0571aad0d8666bb9610e91a82ca05c28f648a6ee18f336c8713/mdcat-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f781561116ca03741dd4c488b79ffc7c", "sha256": "394d7eeaa61955f9a29938a78d27c1cf8b3d1cfa0764ebc824eaa58a4731977d" }, "downloads": -1, "filename": "mdcat-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f781561116ca03741dd4c488b79ffc7c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4876, "upload_time": "2019-04-14T10:58:59", "url": "https://files.pythonhosted.org/packages/da/d6/d66194ed5b754a6f6cfec0a027ac7eedfd26f6961b3bd0320e6e3c544b8b/mdcat-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "eb487125f5a479f0ea0e9d22903426b4", "sha256": "0e4cabdadd9b62232b7560f958e4a9572fd7aab2f1a8583dd42449efe26c4e63" }, "downloads": -1, "filename": "mdcat-1.0.0-py3-none-any.whl", "has_sig": false, "md5_digest": "eb487125f5a479f0ea0e9d22903426b4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3830, "upload_time": "2019-04-14T10:58:57", "url": "https://files.pythonhosted.org/packages/20/16/262a03cde0571aad0d8666bb9610e91a82ca05c28f648a6ee18f336c8713/mdcat-1.0.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f781561116ca03741dd4c488b79ffc7c", "sha256": "394d7eeaa61955f9a29938a78d27c1cf8b3d1cfa0764ebc824eaa58a4731977d" }, "downloads": -1, "filename": "mdcat-1.0.0.tar.gz", "has_sig": false, "md5_digest": "f781561116ca03741dd4c488b79ffc7c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4876, "upload_time": "2019-04-14T10:58:59", "url": "https://files.pythonhosted.org/packages/da/d6/d66194ed5b754a6f6cfec0a027ac7eedfd26f6961b3bd0320e6e3c544b8b/mdcat-1.0.0.tar.gz" } ] }