mdcat - Markdown-friendly variant of cat
Ever struggling quickly documenting your server configuration files in a Git repo or sharing them with your colleagues for the future reference? Welcome to mdcat.
It is a simple Python 3 command line utility, ingesting file path(s) arguments, and printing their content in Markdown-friendly format.
Moreover, it prints the file's absolute path, mode (permissions), and owner (user + group).
Requirements
- Python3 + PIP
Installation
Install/upgrade the tool from PyPI using:
$ pip3 install --upgrade mdcat
Usage
$ mdcat --help
Usage: mdcat [OPTIONS] [FILES]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Example:
$ echo foo >> bar
$ mdcat bar
Output:
File: `/home/pavel/mdcat/bar` (`0644 pavel:users`):
foo
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
Authors
- Pavel Hübner - Initial work
License
This project is licensed under the MIT License - see the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for mdcat 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mdcat-1.0.0.tar.gz | 4.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mdcat-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.7 kB
Release files / mdcat-1.0.0.tar.gz
| Download URL | mdcat-1.0.0.tar.gz |
|---|---|
| Size | 4.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
394d7eeaa61955f9a29938a78d27c1cf8b3d1cfa0764ebc824eaa58a4731977d
|
|
BLAKE2b-256 checksum How to use checksums |
dad6d66194ed5b754a6f6cfec0a027ac7eedfd26f6961b3bd0320e6e3c544b8b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3
|
Release files / mdcat-1.0.0-py3-none-any.whl
| Download URL | mdcat-1.0.0-py3-none-any.whl |
|---|---|
| Size | 3.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0e4cabdadd9b62232b7560f958e4a9572fd7aab2f1a8583dd42449efe26c4e63
|
|
BLAKE2b-256 checksum How to use checksums |
2016262a03cde0571aad0d8666bb9610e91a82ca05c28f648a6ee18f336c8713
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.3
|
