Auto-generated markdown badges.
Project description
auto-markdown-badges
Auto-generated markdown badges. 🧙🖼
Inspired by markdown-badges, I wanted to have a tool which automatically creates badges for me.
🚀 Get started
To install it from PyPI run:
pip install auto-markdown-badges
Then just call it like this:
Usage: auto-markdown-badges generate [OPTIONS] INPUT_FILE
Generates badges from a file.
Options:
INPUT_FILE The file to use for generation of badges.
[required]
-o, --output-file FILE The file to output to.
-p, --placement [header|inplace|footer]
Specify where to place the badge. [default:
Placement.INPLACE]
-h, --help Show this message and exit.
Examples of generated badges can be found in the examples directory.
🤔 How it Works
- It reads the given file, line by line
- It tries to find simple-icons for every word
- It replaces the word with a badge
❤️ Contributing
Contributions are very welcome. Please go ahead and raise an issue if you have one or open a PR. Thank you.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for auto-markdown-badges-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 14e3617390423d0cb8e5b50b1912eeb42b0b8704e1da742a8039b8a3c739cd6a |
|
MD5 | 77d690b2cc0d2844c2271d6fc268e6d0 |
|
BLAKE2b-256 | b19c5b83e2ba1eae201b132d7a90dc1649bd5611e6f4fabf8b9990635966e894 |
Close
Hashes for auto_markdown_badges-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83325aa508a00200da6e70d4ccd99ce555924f3303c81821ebcc5802bef84c48 |
|
MD5 | c5bb6d525287cd31d4108a0da51b4f64 |
|
BLAKE2b-256 | 2ab0e83574ddda93ea22844dfe2f56ebbd9aff305570704d33007f83df7da210 |