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
File details
Details for the file auto-markdown-badges-0.2.1.tar.gz
.
File metadata
- Download URL: auto-markdown-badges-0.2.1.tar.gz
- Upload date:
- Size: 7.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.11.0-1028-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f2f0cf9ecc0be18f1d87c58058166bcf01b02382381b5e1dc39a5d9cc5152a6 |
|
MD5 | 311eb40a2e822df5f47d948272b672cf |
|
BLAKE2b-256 | d3af1547de5b49974037f872db627eb6251e7dd71785506ed186882b90db48d4 |
File details
Details for the file auto_markdown_badges-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: auto_markdown_badges-0.2.1-py3-none-any.whl
- Upload date:
- Size: 9.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.1.13 CPython/3.9.10 Linux/5.11.0-1028-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed5ad814b0a8c5fbb224be3f443131b8a7fe113a7936ebdda5e820dd30606e58 |
|
MD5 | 06e48b641c984b42c5b686141cf716aa |
|
BLAKE2b-256 | e8e2ca3963f2fce57ff9fffb8f390e17f73501a07028fe98a86f77c1997da435 |