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] FILE
Generates badges from a file.
Options:
FILE The file to use for generation of badges. [required]
--inplace Writes back to file instead of to stdout.
-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, word by word
- It tries to find simple-icons for every word
- It replaces the word by badge either inplace or writes the output to console
❤️ 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.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 265efa2b7ff029894000e9f72a21a49602add46e266e558c7475cb65b5553640 |
|
MD5 | f2f298b31fe93a22e03fb56f3566faef |
|
BLAKE2b-256 | 24d2537ea5aaac7aff123b6f1e787d94823d8d4467754f4d2f3e68a04517d769 |
Close
Hashes for auto_markdown_badges-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3dacae6df94718adf8ea692bd5fc7db22ef9ad7c300ff7d0eed67495b358119c |
|
MD5 | 4ce3558201eb1aeaa1de4e343615fba7 |
|
BLAKE2b-256 | e38ba03c8116c46f25c26770c44378d5fa1ba4c79b664870420909c74680b1bd |