Skip to main content

Auto-generated markdown badges.

Project description

auto-markdown-badges

pre-commit.ci status test workflow codeql-analysis workflow codecov PyPI version License PyPI - Python Version PyPI version

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

  1. It reads the given file, line by line
  2. It tries to find simple-icons for every word
  3. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

auto-markdown-badges-0.2.1.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

auto_markdown_badges-0.2.1-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page