<h1 align="center">Welcome to README Coverage Badger 👋</h1>
<p align="center">
<a href="https://pypi.python.org/pypi/readme-coverage-badger" target="_blank">
<img src="https://img.shields.io/pypi/v/readme-coverage-badger.svg" alt="PyPi">
</a>
<a href="https://pypi.org/project/readme-coverage-badger" target="_blank">
<img src="https://img.shields.io/pypi/pyversions/readme-coverage-badger" alt="PyPI - Python Version">
</a>
<a href="https://github.com/engineervix/readme-coverage-badger/actions/workflows/main.yml" target="_blank">
<img src="https://github.com/engineervix/readme-coverage-badger/actions/workflows/main.yml/badge.svg" alt="Build Status">
</a>
<a href="https://codecov.io/gh/engineervix/readme-coverage-badger" target="_blank">
<img src="https://codecov.io/gh/engineervix/readme-coverage-badger/branch/master/graph/badge.svg" alt="codecov">
</a>
<a href="https://results.pre-commit.ci/latest/github/engineervix/readme-coverage-badger/master" target="_blank">
<img src="https://results.pre-commit.ci/badge/github/engineervix/readme-coverage-badger/master.svg" alt="pre-commit.ci status">
</a>
<a href="https://pyup.io/repos/github/engineervix/readme-coverage-badger/" target="_blank">
<img src="https://pyup.io/repos/github/engineervix/readme-coverage-badger/shield.svg" alt="Updates">
</a>
<a href="https://pypi.org/project/readme-coverage-badger" target="_blank">
<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/readme-coverage-badger">
</a>
<a href="https://github.com/engineervix/readme-coverage-badger/commits/master" target="_blank">
<img alt="GitHub commits since latest release (by SemVer)" src="https://img.shields.io/github/commits-since/engineervix/readme-coverage-badger/latest/master">
</a>
</p>
<p align="center">
<a href="https://opensource.org/licenses/BSD-3-Clause">
<img src="https://img.shields.io/badge/License-BSD%203--Clause-blue.svg" alt="License">
</a>
<a href="https://github.com/psf/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black">
</a>
<a href="https://conventionalcommits.org">
<img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" alt="Conventional Commits">
</a>
<a href="https://commitizen-tools.github.io/commitizen/">
<img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg" alt="Commitizen friendly">
</a>
</p>
> Generates a coverage badge using coverage.py and the shields.io service. Your README file is then updated with the generated badge.
<p align="center">
<img src="https://github.com/engineervix/readme-coverage-badger/blob/assets/demo.gif" alt="demo.gif">
</p>
<!--  -->
**Source Code**: [github.com/engineervix/readme-coverage-badger](https://github.com/engineervix/readme-coverage-badger)
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Contents** _generated with [DocToc](https://github.com/thlorenz/doctoc)_
- [Why this project?](#why-this-project)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [💻 Development](#-development)
- [First things first](#first-things-first)
- [Getting Started](#getting-started)
- [Tests](#tests)
- [Code Formatting](#code-formatting)
- [Author](#author)
- [🤝 Contributing](#-contributing)
- [Show your support](#show-your-support)
- [✅ TODO](#-todo)
- [core](#core)
- [docs](#docs)
- [other](#other)
- [📝 License](#-license)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Why this project?
There are so many excellent coverage badge generation tools out there, why do we need another one? Well, at the time of writing this package (circa early 2021), all the existing tools (for example, [coverage-badge](https://github.com/dbrgn/coverage-badge)) I had come across ended at generating SVG/PNG files/strings/Base64 images. What you do with this remains entirely up to you.
Now, it is often much easier to simply use online services such as [codecov.io](https://about.codecov.io/) and [coveralls.io](https://coveralls.io/). These services are free for open source projects, but require a monthly subscription for private repos. Many times, we work on private repos, and we wanna be able to automatically have coverage badges in our READMEs. What if you are unable to pay such subscription fees, or maybe you don't want to use a SaaS? Your solution becomes to generate your own badge!
This is where this project comes in. It **automatically generates your project's coverage badge using the [shields.io](https://shields.io/) service, and then updates your README** accordingly, in just one command! That's all it does, resonating with the Unix philosophy of doing one thing and doing it well. The main idea for this came from [istanbul-badges-readme](https://github.com/olavoparno/istanbul-badges-readme), which does exactly the same thing for JavaScript projects. You will see that these two projects have quite a lot in common.
After using [istanbul-badges-readme](https://github.com/olavoparno/istanbul-badges-readme), I searched for a python alternative but couldn't find anything suitable. The closest I found was [coverage-badge](https://github.com/dbrgn/coverage-badge), and if you look at this project's code, you will see a lot of similarities with [coverage-badge](https://github.com/dbrgn/coverage-badge)!
If what you're looking for is a powerful, _general purpose badge generation tool_ for your projects, then you should probably check out projects like [anybadge](https://github.com/jongracecox/anybadge) and [genbadge](https://github.com/smarie/python-genbadge/).
## Features
- automatically generates your project's coverage badge using the [shields.io](https://shields.io/) service, and then updates your project's README with the newly generated badge
- simple CLI tool (`readme-cov`) with helpful messages
- tested on python 3.8 to 3.12 with coverage ≥ 84%
- free software: BSD-3-Clause license
- generates different colours depending on the coverage percentage. Optionally generate plain colour (green) regardless of percentage
- minimal external dependencies – this tool only has 2 external dependencies; [Coverage.py](https://github.com/nedbat/coveragepy) (obviously!) and [colorama](https://github.com/tartley/colorama) (for cross-platform coloured terminal output)
The table below shows the coverage thresholds, associated colours and examples of generated badges:
| Coverage | Colour | Example |
| ------------------- | ----------- | ------------------------------------------------------------------------------------------ |
| 0 ≤ coverage < 40 | red |  |
| 40 ≤ coverage < 60 | orange |  |
| 60 ≤ coverage < 75 | yellow |  |
| 75 ≤ coverage < 90 | yellowgreen |  |
| 90 ≤ coverage < 95 | green |  |
| 95 ≤ coverage ≤ 100 | brightgreen |  |
## Installation
```sh
pip install readme-coverage-badger
```
## Usage
**Note**: Before using the tool, ensure that you insert a string of the form `![Code Coverage]()` or `` in your project's README.
```txt
readme-cov [-h] [-v] [-p]
optional arguments:
-h, --help show the help message and exit
-v, --version show program's version number and exit
-p, --plain Plain colour mode. Standard green badge.
```
The tool operates on the basis of the following assumptions:
- you have a README.md or README file at the root of your project
- your README file is in markdown format. I know, some Pythonistas prefer restructuredtext! Sadly, this isn't supported (yet)
- Somewhere in your your README is a string in the form: `![Code Coverage]()` or ``. This is what gets updated in-place (using [`re.sub()`](https://docs.python.org/3.12/library/re.html#re.sub)) when the script runs.
- the script is called from the root of your project repo, which has coverage.py already configured, and the coverage already updated (you have already run your tests prior to running the script)
- If the coverage badge in your README file is already up to date, your README file won't be updated, you will only be notified
## 💻 Development
### First things first
- ensure that you have [Python 3.8+](https://www.python.org/) on your machine, and that you are able to configure python [**virtual environment**](https://realpython.com/python-virtual-environments-a-primer/)s.
- ensure that you have [git](https://git-scm.com/) setup on your machine.
### Getting Started
First, [fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) this repository, then fire up your command prompt and ...
1. Clone the forked repository
2. Navigate to the cloned project directory: `cd readme_coverage_badger`
3. activate your python virtual environment and `pip install --upgrade pip`
4. Install dependencies: `pip install -r requirements_dev.txt`
5. Setup [pre-commit](https://pre-commit.com/) by running `pre-commit install` followed by `pre-commit install --hook-type commit-msg`. Optionally run `pre-commit run --all-files` to make sure your pre-commit setup is okay.
At this stage, hopefully everything should be working fine, and you should be able to start hacking on the project.
You can run the application via `invoke run` or
```sh
python readme_coverage_badger/__main__.py
```
### Tests
Simply run `pytest` or `invoke test` to run tests in your virtual environment.
Test other Python versions by running `tox`.
### Code Formatting
- Run `invoke lint` to run [`flake8`](https://flake8.pycqa.org/en/latest/), [`black`](https://black.readthedocs.io/en/stable/), [`isort`](https://pycqa.github.io/isort/) and [`mypy`](https://mypy.readthedocs.io/en/stable/) on the code.
- If you get any errors from `black` and/or `isort`, run `invoke lint --fix` or `invoke lint -f` so that black and isort can format your files. Alternatively, just run `pre-commit`. You can take a look at [.pre-commit-config.yaml](https://github.com/engineervix/readme-coverage-badger/blob/master/.pre-commit-config.yaml).
## Author
👤 **Victor Miti**
- Blog: <https://blog.victor.co.zm>
- Twitter: [](https://twitter.com/engineervix)
- Github: [@engineervix](https://github.com/engineervix)
## 🤝 Contributing
Contributions, issues and feature requests are most welcome! A good place to start is by helping out with the unchecked items in the [TODO](#-todo) section of this README!
Feel free to check the [issues page](https://github.com/engineervix/readme-coverage-badger/issues) and take a look at the [contributing guide](https://github.com/engineervix/readme-coverage-badger/blob/master/CONTRIBUTING.md) before you get started. In addition, please note the following:
- if you're making code contributions, please try and write some tests to accompany your code, and ensure that the tests pass. Also, were necessary, update the docs so that they reflect your changes.
- commit your changes via `cz commit`. Follow the prompts. When you're done, `pre-commit` will be invoked to ensure that your contributions and commits follow defined conventions. See `pre-commit-config.yaml` for more details.
- your commit messages should follow the conventions described [here](https://www.conventionalcommits.org/en/v1.0.0/). Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like `git merge` and `git revert`.
Once you are done, please create a [pull request](https://github.com/engineervix/readme-coverage-badger/pulls).
## Show your support
Please give a ⭐️ if this project helped you!
## ✅ TODO
### core
- [ ] Cater for not only markdown but also restructuredtext, and automatically detect if a file's syntax is markdown or restructuredtext if no extension given
- [ ] Provide option to generate badge in HTML format
- [ ] Provide option to generate to `stdout` and skip substitution in a README file. This could be useful if you're using the tool in a script and you just want the result so that you can use it elsewhere.
- [ ] Allow for flexibility in choosing whatever colours one wants
- [ ] Allow for specifying _Alt Text_ on the badge URL, for example `![Alt Text]()` or ``
- [ ] Make the codebase fully typed
- [ ] Improve the Tests by [parametrizing](https://docs.pytest.org/en/stable/example/parametrize.html) fixtures and test functions
- [x] improve CI/CD to cater for GNU/Linux, Mac OS X and Windows
- [ ] Create pre-commit hook
### docs
- [x] Add a screenshot / demo in this README
- [ ] Create standalone documentation for hosting either on Github Pages or readthedocs. This README is already detailed enough to serve as documentation!
### other
- [ ] It would be fun if we had some kind of a [badger](https://en.wikipedia.org/wiki/Badger) logo!
## 📝 License
Copyright © 2021 - present [Victor Miti](https://github.com/engineervix).
This project is licensed under the terms of the [BSD-3-Clause](https://github.com/engineervix/readme-coverage-badger/blob/main/LICENSE) license.
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_
---
# Changelog
All notable changes to this project will be documented here.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project attempts to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [v1.0.1](https://github.com/engineervix/readme-coverage-badger/compare/v1.0.0...v1.0.1) (2024-07-05)
### 🐛 Bug Fixes
* broken logger configuration introduced in 1.0.0 ([7e27daa](https://github.com/engineervix/readme-coverage-badger/commit/7e27daaf552e4fc4cd6a2cf7860726720dc62bea))
## [v1.0.0](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.2...v1.0.0) (2024-07-05)
### ⚠ BREAKING CHANGES
* Python <3.8 no longer supported
### ⚙️ Build System
* bump outdated dependencies to latest versions ([63a5f78](https://github.com/engineervix/readme-coverage-badger/commit/63a5f782de106a5358f97e1010afbcc88ccb1065))
* update outdated pre-commit hooks ([775fe7e](https://github.com/engineervix/readme-coverage-badger/commit/775fe7e5d55685118b0d441a4c9f2c990a92b428))
### 🚀 Features
* add support for Python 3.11, 3.12 & drop Python 3.6 and 3.7 ([e30c803](https://github.com/engineervix/readme-coverage-badger/commit/e30c8035b208f1068f763a84f7f6ff7825d71e25))
### 📝 Docs
* update docs ([151a20f](https://github.com/engineervix/readme-coverage-badger/commit/151a20f453dfb8d0fde103c8b172d16329e4f1ed))
### 💄 Styling
* update Black's target versions ([52ee283](https://github.com/engineervix/readme-coverage-badger/commit/52ee283e6b6c27022128d575505e77c2194a5232))
### ♻️ Code Refactoring
* update logging configuration ([89c8276](https://github.com/engineervix/readme-coverage-badger/commit/89c827657372a0ecfae29a2d8585f33f33c3ecfb))
### 👷 CI/CD
* add manually triggered workflow ([aac0ae3](https://github.com/engineervix/readme-coverage-badger/commit/aac0ae3668cdce216d12d7dd8189b4eb1cc37dcc))
* bump codecov/codecov-action from v2 to v4 ([fece05b](https://github.com/engineervix/readme-coverage-badger/commit/fece05bc48a6a2e022f18aaf1960eeab2f513098))
* disable publishing to testPyPI ([ebe85af](https://github.com/engineervix/readme-coverage-badger/commit/ebe85af548d3087aae622eb49302c350b94227bb))
* update CI to use latest actions and OSes ([f0a92d3](https://github.com/engineervix/readme-coverage-badger/commit/f0a92d3c52b6d76d578cd5b3e74c5352afb4cf3e))
* you need an upload token from codecov.io ([806eeb9](https://github.com/engineervix/readme-coverage-badger/commit/806eeb97cd723d223afc2dc19ee669292eb70334))
## [v0.1.2](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.1...v0.1.2) (2022-01-21)
### 📝 Docs
* **changelog:** add note on version 0.1.0 ([7e7b8a6](https://github.com/engineervix/readme-coverage-badger/commit/7e7b8a6d77c29878d9e65e366a7633d1f7a85ccf))
* **changelog:** regenerate using [standard-version](https://github.com/conventional-changelog/standard-version) ([90da4da](https://github.com/engineervix/readme-coverage-badger/commit/90da4da6bd3440f528ed3e8f2b9d452ad7c1fb81))
* **readme:** add a GIF to demonstrate the tool ([82afdbe](https://github.com/engineervix/readme-coverage-badger/commit/82afdbeffe125cea3ef66e84af03d1c5d0eee926))
* **readme:** general reorganisation of the docs – centre the badges, categorize the TODOs and add some minor improvements ([d46fcbb](https://github.com/engineervix/readme-coverage-badger/commit/d46fcbb59b427700f34f9faebfdc92be28fbf61b))
### 💄 Styling
* **changelog:** move <hr> to the end of the file ([aa9b442](https://github.com/engineervix/readme-coverage-badger/commit/aa9b44220c757246a369a0558226ebe434daeb50))
* update changelog configuration ([0e0fd06](https://github.com/engineervix/readme-coverage-badger/commit/0e0fd0608412665fe080adffd2c86fd3ddbe410e))
### ⚙️ Build System
* **deps-dev:** bump faker from 8.9.1 to 8.10.0 ([#3](https://github.com/engineervix/readme-coverage-badger/issues/3)) ([63c50d9](https://github.com/engineervix/readme-coverage-badger/commit/63c50d974a7ae16124d886f88525aa24ec588c98))
* **deps-dev:** bump invoke from 1.5.0 to 1.6.0 ([#5](https://github.com/engineervix/readme-coverage-badger/issues/5)) ([f62aa4e](https://github.com/engineervix/readme-coverage-badger/commit/f62aa4e02df76def5539d8de104731904e40b9fa))
* **deps-dev:** bump isort from 5.9.1 to 5.9.2 ([#4](https://github.com/engineervix/readme-coverage-badger/issues/4)) ([81837d2](https://github.com/engineervix/readme-coverage-badger/commit/81837d2ba942e61180f4f3c5ffed178f8e1ac7fb))
* **deps-dev:** update outdated packages ([45bd516](https://github.com/engineervix/readme-coverage-badger/commit/45bd516bd226fb4d73c2ba0197b3a04fa0fba68e))
* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.17.12 ([63cf405](https://github.com/engineervix/readme-coverage-badger/commit/63cf405872557b4086e5b8b9ca4dfb7acaa90646))
* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.17.13 ([69b65cc](https://github.com/engineervix/readme-coverage-badger/commit/69b65ccae0d2767c8ddec04019a5d25b46321280))
* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.18.0 ([50a946f](https://github.com/engineervix/readme-coverage-badger/commit/50a946ffc186ea63ed4338647e19b5c78ba03c6a))
* **deps-dev:** update precommit hook pre-commit/mirrors-isort to v5.9.2 ([922f932](https://github.com/engineervix/readme-coverage-badger/commit/922f9326e47612a4ce600156b64cceb13babb278))
* **deps-dev:** update precommit hook pycqa/isort to v5.9.3 ([300dd31](https://github.com/engineervix/readme-coverage-badger/commit/300dd317ea2ae8346cb2334f8453744884f58819))
### 🐛 Bug Fixes
* enforce coverage<6 and ensure python 3.10 support ([e2c2f92](https://github.com/engineervix/readme-coverage-badger/commit/e2c2f92e5d4d2bc422d7029e2cced96083d7058a))
### 👷 CI/CD
* add `renovate.json` ([#6](https://github.com/engineervix/readme-coverage-badger/issues/6)) ([194b29e](https://github.com/engineervix/readme-coverage-badger/commit/194b29ea4b137774e8f1a0cb953462e8f1d2ffbb))
* add GH action to greet first-time contributors ([8085515](https://github.com/engineervix/readme-coverage-badger/commit/80855154f24c3239485738a9204a089474bb000a))
* add manually triggered workflow ([c8b3e66](https://github.com/engineervix/readme-coverage-badger/commit/c8b3e66e21fa857da7c72f19e0442e36d764e3a1))
* add the lint job to python 3.8 on TRavis CI ([0d20cbf](https://github.com/engineervix/readme-coverage-badger/commit/0d20cbf9ebd244a739360aa67f8f4a172351fbef))
* correct the Travis CI config to support PEP 517 builds ([9e476a1](https://github.com/engineervix/readme-coverage-badger/commit/9e476a1211d232516d1c90416c42142add8ab729))
* customize renovate config to allow automatic dependency management ([8fcc766](https://github.com/engineervix/readme-coverage-badger/commit/8fcc766910feae114ebdeb7e6cc7e695e3557a3f))
* disable publishing to testPyPI ([00c8783](https://github.com/engineervix/readme-coverage-badger/commit/00c87838a1007037bfbd7221c0d4018412fbe5a6))
* improved release workfow through some custom hacks ([ee12b8e](https://github.com/engineervix/readme-coverage-badger/commit/ee12b8e22d2d084d0ad8f1a8a3663f4a8c62d4c5))
* pre-commit autoupdate ([#10](https://github.com/engineervix/readme-coverage-badger/issues/10)) ([c4a52df](https://github.com/engineervix/readme-coverage-badger/commit/c4a52dffb0dbee881971935b8eb52f4fdf1fcbd6))
* **pre-commit.ci:** pre-commit autoupdate ([#12](https://github.com/engineervix/readme-coverage-badger/issues/12)) ([94c2929](https://github.com/engineervix/readme-coverage-badger/commit/94c2929d5b3ed6b847f7092b1c15b805795d44f3))
* remove `dependabot.yml` configuration file ([bc0568b](https://github.com/engineervix/readme-coverage-badger/commit/bc0568badcf3491c6b5fd03397abb051bf54e36b))
* **renovate.json:** fix configuration ([#9](https://github.com/engineervix/readme-coverage-badger/issues/9)) ([14dd8b3](https://github.com/engineervix/readme-coverage-badger/commit/14dd8b360e2b759c375474e585fb917f86ddb8b6))
* run tests on GNU/Linux, Mac OS X and Windows ([2a2b446](https://github.com/engineervix/readme-coverage-badger/commit/2a2b446ef756edc0f8ea1d6a0ee9803c77b28174))
* run tests on Python 3.10 ([6e93962](https://github.com/engineervix/readme-coverage-badger/commit/6e9396246f40d015f854632d9304149e973ebf38))
* switch from Travis CI to GitHub Actions ([ba1b1fb](https://github.com/engineervix/readme-coverage-badger/commit/ba1b1fb39deb71575b8e178189a509e5fde59b2c))
* **travis:** revert to the initial setup defined in f53d6a ([4db1f32](https://github.com/engineervix/readme-coverage-badger/commit/4db1f3292329e9ea9a3c8e6c4fed59933ad54dd5))
## [v0.1.1](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.0...v0.1.1) (2021-07-07)
### 📝 Docs
* **readme:** additional badges showing PyPi download stats, supported Python versions and commit activity ([5c735b2](https://github.com/engineervix/readme-coverage-badger/commit/5c735b2a88c0423a937afb03dd900ed824e58b32))
* **readme:** correct the Travis CI Badge URL to point to the master branch ([275443e](https://github.com/engineervix/readme-coverage-badger/commit/275443e2a3711c1d2687f08d9b14f3f191f3ac61))
* **readme:** fix typo in opening paragraph of "Why this Project?" ([118f9ba](https://github.com/engineervix/readme-coverage-badger/commit/118f9ba30788cbdb0d822fdc994f033c4e67851c))
* **readme:** minor grammar improvements ([ad63721](https://github.com/engineervix/readme-coverage-badger/commit/ad6372176f4dfb6e24921af1751bd1562fd16d8a))
### ⚙️ Build System / Dependencies
* **deps-dev:** bump commitizen from 2.17.11 to 2.17.12 ([#2](https://github.com/engineervix/readme-coverage-badger/issues/2)) ([9e769fd](https://github.com/engineervix/readme-coverage-badger/commit/9e769fdf2016b7101a13bfad1d50cd3b552aee5b))
### 🛠 Miscellaneous
* deploy on PyPi only when you create (and push) new tags on master ([c34224f](https://github.com/engineervix/readme-coverage-badger/commit/c34224f0beb24470b75a1cc0b4f98d396849dcb9))
* **pyproject.toml:** make isort compatible with black, just like the pre-commit configuration ([ba0a438](https://github.com/engineervix/readme-coverage-badger/commit/ba0a4380184daa33bfe63399dfe00111b4795940))
### 🪠 Maintenance
* **travis:** replace __token__ with actual username ([87fddc2](https://github.com/engineervix/readme-coverage-badger/commit/87fddc26289c2afe05ebd04557e83c5962df40f7))
### 🐛 Bug Fixes
* bug in `readme_location` ([df68dc2](https://github.com/engineervix/readme-coverage-badger/commit/df68dc23bde654053b82a8abf6f55f81a7a0a636))
## [v0.1.0](https://github.com/engineervix/readme-coverage-badger/compare/8c618b...v0.1.0) (2021-07-06)
### 🪠 Maintenance
* automatic deployment on PyPi ([f53d6ae](https://github.com/engineervix/readme-coverage-badger/commit/f53d6ae33dde87788215f238086de28f04958e23))
### 🛠 Miscellaneous
* fix typo in repo name ([6d9cb11](https://github.com/engineervix/readme-coverage-badger/commit/6d9cb11ef5f6398c1ce501c5b8b2df391dfdff6f))
* fix typos on badge URLs ([d8b32ac](https://github.com/engineervix/readme-coverage-badger/commit/d8b32acba74a282aa38877e6af93e734252492b2))
* only install codecov on travis ([8a3bd55](https://github.com/engineervix/readme-coverage-badger/commit/8a3bd559d78ce7c810c4f3ffc5b9be5e1895e5cc))
* remove detect-aws-credentials hook ([4b571d8](https://github.com/engineervix/readme-coverage-badger/commit/4b571d87f7eb7d15d78ade48590de0ca277a3728))
* simplify travis setup, for now ([958aa6d](https://github.com/engineervix/readme-coverage-badger/commit/958aa6dfc6cf01a025aff05d250173b331df5e8d))
* use focal instead of default bionic ([5116bd6](https://github.com/engineervix/readme-coverage-badger/commit/5116bd602fcf78563272d886c24dac427b704638))
# BSD 3-Clause License
Copyright (c) 2021 - present, Victor Miti
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://github.com/engineervix/readme-coverage-badger/",
"name": "readme-coverage-badger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "coverage badge shield readme",
"author": "Victor Miti",
"author_email": "hello@victor.co.zm",
"download_url": "https://files.pythonhosted.org/packages/0c/89/ad9e466878cd009df78845cd178d4353866260cd2864475947434c402c84/readme_coverage_badger-1.0.1.tar.gz",
"platform": "any",
"description": "<h1 align=\"center\">Welcome to README Coverage Badger \ud83d\udc4b</h1>\n\n<p align=\"center\">\n<a href=\"https://pypi.python.org/pypi/readme-coverage-badger\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/readme-coverage-badger.svg\" alt=\"PyPi\">\n</a>\n<a href=\"https://pypi.org/project/readme-coverage-badger\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/pyversions/readme-coverage-badger\" alt=\"PyPI - Python Version\">\n</a>\n<a href=\"https://github.com/engineervix/readme-coverage-badger/actions/workflows/main.yml\" target=\"_blank\">\n <img src=\"https://github.com/engineervix/readme-coverage-badger/actions/workflows/main.yml/badge.svg\" alt=\"Build Status\">\n</a>\n<a href=\"https://codecov.io/gh/engineervix/readme-coverage-badger\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/engineervix/readme-coverage-badger/branch/master/graph/badge.svg\" alt=\"codecov\">\n</a>\n<a href=\"https://results.pre-commit.ci/latest/github/engineervix/readme-coverage-badger/master\" target=\"_blank\">\n <img src=\"https://results.pre-commit.ci/badge/github/engineervix/readme-coverage-badger/master.svg\" alt=\"pre-commit.ci status\">\n</a>\n<a href=\"https://pyup.io/repos/github/engineervix/readme-coverage-badger/\" target=\"_blank\">\n <img src=\"https://pyup.io/repos/github/engineervix/readme-coverage-badger/shield.svg\" alt=\"Updates\">\n</a>\n<a href=\"https://pypi.org/project/readme-coverage-badger\" target=\"_blank\">\n <img alt=\"PyPI - Downloads\" src=\"https://img.shields.io/pypi/dm/readme-coverage-badger\">\n</a>\n<a href=\"https://github.com/engineervix/readme-coverage-badger/commits/master\" target=\"_blank\">\n <img alt=\"GitHub commits since latest release (by SemVer)\" src=\"https://img.shields.io/github/commits-since/engineervix/readme-coverage-badger/latest/master\">\n</a>\n</p>\n\n<p align=\"center\">\n<a href=\"https://opensource.org/licenses/BSD-3-Clause\">\n <img src=\"https://img.shields.io/badge/License-BSD%203--Clause-blue.svg\" alt=\"License\">\n</a>\n<a href=\"https://github.com/psf/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg\" alt=\"Code style: black\">\n</a>\n<a href=\"https://conventionalcommits.org\">\n <img src=\"https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square\" alt=\"Conventional Commits\">\n</a>\n<a href=\"https://commitizen-tools.github.io/commitizen/\">\n <img src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg\" alt=\"Commitizen friendly\">\n</a>\n</p>\n\n> Generates a coverage badge using coverage.py and the shields.io service. Your README file is then updated with the generated badge.\n\n<p align=\"center\">\n <img src=\"https://github.com/engineervix/readme-coverage-badger/blob/assets/demo.gif\" alt=\"demo.gif\">\n</p>\n<!--  -->\n\n**Source Code**: [github.com/engineervix/readme-coverage-badger](https://github.com/engineervix/readme-coverage-badger)\n\n<!-- START doctoc generated TOC please keep comment here to allow auto update -->\n<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->\n\n**Contents** _generated with [DocToc](https://github.com/thlorenz/doctoc)_\n\n- [Why this project?](#why-this-project)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [\ud83d\udcbb Development](#-development)\n - [First things first](#first-things-first)\n - [Getting Started](#getting-started)\n - [Tests](#tests)\n - [Code Formatting](#code-formatting)\n- [Author](#author)\n- [\ud83e\udd1d Contributing](#-contributing)\n- [Show your support](#show-your-support)\n- [\u2705 TODO](#-todo)\n - [core](#core)\n - [docs](#docs)\n - [other](#other)\n- [\ud83d\udcdd License](#-license)\n\n<!-- END doctoc generated TOC please keep comment here to allow auto update -->\n\n## Why this project?\n\nThere are so many excellent coverage badge generation tools out there, why do we need another one? Well, at the time of writing this package (circa early 2021), all the existing tools (for example, [coverage-badge](https://github.com/dbrgn/coverage-badge)) I had come across ended at generating SVG/PNG files/strings/Base64 images. What you do with this remains entirely up to you.\n\nNow, it is often much easier to simply use online services such as [codecov.io](https://about.codecov.io/) and [coveralls.io](https://coveralls.io/). These services are free for open source projects, but require a monthly subscription for private repos. Many times, we work on private repos, and we wanna be able to automatically have coverage badges in our READMEs. What if you are unable to pay such subscription fees, or maybe you don't want to use a SaaS? Your solution becomes to generate your own badge!\n\nThis is where this project comes in. It **automatically generates your project's coverage badge using the [shields.io](https://shields.io/) service, and then updates your README** accordingly, in just one command! That's all it does, resonating with the Unix philosophy of doing one thing and doing it well. The main idea for this came from [istanbul-badges-readme](https://github.com/olavoparno/istanbul-badges-readme), which does exactly the same thing for JavaScript projects. You will see that these two projects have quite a lot in common.\n\nAfter using [istanbul-badges-readme](https://github.com/olavoparno/istanbul-badges-readme), I searched for a python alternative but couldn't find anything suitable. The closest I found was [coverage-badge](https://github.com/dbrgn/coverage-badge), and if you look at this project's code, you will see a lot of similarities with [coverage-badge](https://github.com/dbrgn/coverage-badge)!\n\nIf what you're looking for is a powerful, _general purpose badge generation tool_ for your projects, then you should probably check out projects like [anybadge](https://github.com/jongracecox/anybadge) and [genbadge](https://github.com/smarie/python-genbadge/).\n\n## Features\n\n- automatically generates your project's coverage badge using the [shields.io](https://shields.io/) service, and then updates your project's README with the newly generated badge\n- simple CLI tool (`readme-cov`) with helpful messages\n- tested on python 3.8 to 3.12 with coverage \u2265 84%\n- free software: BSD-3-Clause license\n- generates different colours depending on the coverage percentage. Optionally generate plain colour (green) regardless of percentage\n- minimal external dependencies \u2013 this tool only has 2 external dependencies; [Coverage.py](https://github.com/nedbat/coveragepy) (obviously!) and [colorama](https://github.com/tartley/colorama) (for cross-platform coloured terminal output)\n\nThe table below shows the coverage thresholds, associated colours and examples of generated badges:\n\n| Coverage | Colour | Example |\n| ------------------- | ----------- | ------------------------------------------------------------------------------------------ |\n| 0 \u2264 coverage < 40 | red |  |\n| 40 \u2264 coverage < 60 | orange |  |\n| 60 \u2264 coverage < 75 | yellow |  |\n| 75 \u2264 coverage < 90 | yellowgreen |  |\n| 90 \u2264 coverage < 95 | green |  |\n| 95 \u2264 coverage \u2264 100 | brightgreen |  |\n\n## Installation\n\n```sh\npip install readme-coverage-badger\n```\n\n## Usage\n\n**Note**: Before using the tool, ensure that you insert a string of the form `![Code Coverage]()` or `` in your project's README.\n\n```txt\nreadme-cov [-h] [-v] [-p]\n\noptional arguments:\n -h, --help show the help message and exit\n -v, --version show program's version number and exit\n -p, --plain Plain colour mode. Standard green badge.\n```\n\nThe tool operates on the basis of the following assumptions:\n\n- you have a README.md or README file at the root of your project\n- your README file is in markdown format. I know, some Pythonistas prefer restructuredtext! Sadly, this isn't supported (yet)\n- Somewhere in your your README is a string in the form: `![Code Coverage]()` or ``. This is what gets updated in-place (using [`re.sub()`](https://docs.python.org/3.12/library/re.html#re.sub)) when the script runs.\n- the script is called from the root of your project repo, which has coverage.py already configured, and the coverage already updated (you have already run your tests prior to running the script)\n- If the coverage badge in your README file is already up to date, your README file won't be updated, you will only be notified\n\n## \ud83d\udcbb Development\n\n### First things first\n\n- ensure that you have [Python 3.8+](https://www.python.org/) on your machine, and that you are able to configure python [**virtual environment**](https://realpython.com/python-virtual-environments-a-primer/)s.\n- ensure that you have [git](https://git-scm.com/) setup on your machine.\n\n### Getting Started\n\nFirst, [fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) this repository, then fire up your command prompt and ...\n\n1. Clone the forked repository\n2. Navigate to the cloned project directory: `cd readme_coverage_badger`\n3. activate your python virtual environment and `pip install --upgrade pip`\n4. Install dependencies: `pip install -r requirements_dev.txt`\n5. Setup [pre-commit](https://pre-commit.com/) by running `pre-commit install` followed by `pre-commit install --hook-type commit-msg`. Optionally run `pre-commit run --all-files` to make sure your pre-commit setup is okay.\n\nAt this stage, hopefully everything should be working fine, and you should be able to start hacking on the project.\n\nYou can run the application via `invoke run` or\n\n```sh\npython readme_coverage_badger/__main__.py\n```\n\n### Tests\n\nSimply run `pytest` or `invoke test` to run tests in your virtual environment.\n\nTest other Python versions by running `tox`.\n\n### Code Formatting\n\n- Run `invoke lint` to run [`flake8`](https://flake8.pycqa.org/en/latest/), [`black`](https://black.readthedocs.io/en/stable/), [`isort`](https://pycqa.github.io/isort/) and [`mypy`](https://mypy.readthedocs.io/en/stable/) on the code.\n- If you get any errors from `black` and/or `isort`, run `invoke lint --fix` or `invoke lint -f` so that black and isort can format your files. Alternatively, just run `pre-commit`. You can take a look at [.pre-commit-config.yaml](https://github.com/engineervix/readme-coverage-badger/blob/master/.pre-commit-config.yaml).\n\n## Author\n\n\ud83d\udc64 **Victor Miti**\n\n- Blog: <https://blog.victor.co.zm>\n- Twitter: [](https://twitter.com/engineervix)\n- Github: [@engineervix](https://github.com/engineervix)\n\n## \ud83e\udd1d Contributing\n\nContributions, issues and feature requests are most welcome! A good place to start is by helping out with the unchecked items in the [TODO](#-todo) section of this README!\n\nFeel free to check the [issues page](https://github.com/engineervix/readme-coverage-badger/issues) and take a look at the [contributing guide](https://github.com/engineervix/readme-coverage-badger/blob/master/CONTRIBUTING.md) before you get started. In addition, please note the following:\n\n- if you're making code contributions, please try and write some tests to accompany your code, and ensure that the tests pass. Also, were necessary, update the docs so that they reflect your changes.\n- commit your changes via `cz commit`. Follow the prompts. When you're done, `pre-commit` will be invoked to ensure that your contributions and commits follow defined conventions. See `pre-commit-config.yaml` for more details.\n- your commit messages should follow the conventions described [here](https://www.conventionalcommits.org/en/v1.0.0/). Write your commit message in the imperative: \"Fix bug\" and not \"Fixed bug\" or \"Fixes bug.\" This convention matches up with commit messages generated by commands like `git merge` and `git revert`.\n Once you are done, please create a [pull request](https://github.com/engineervix/readme-coverage-badger/pulls).\n\n## Show your support\n\nPlease give a \u2b50\ufe0f if this project helped you!\n\n## \u2705 TODO\n\n### core\n\n- [ ] Cater for not only markdown but also restructuredtext, and automatically detect if a file's syntax is markdown or restructuredtext if no extension given\n- [ ] Provide option to generate badge in HTML format\n- [ ] Provide option to generate to `stdout` and skip substitution in a README file. This could be useful if you're using the tool in a script and you just want the result so that you can use it elsewhere.\n- [ ] Allow for flexibility in choosing whatever colours one wants\n- [ ] Allow for specifying _Alt Text_ on the badge URL, for example `![Alt Text]()` or ``\n- [ ] Make the codebase fully typed\n- [ ] Improve the Tests by [parametrizing](https://docs.pytest.org/en/stable/example/parametrize.html) fixtures and test functions\n- [x] improve CI/CD to cater for GNU/Linux, Mac OS X and Windows\n- [ ] Create pre-commit hook\n\n### docs\n\n- [x] Add a screenshot / demo in this README\n- [ ] Create standalone documentation for hosting either on Github Pages or readthedocs. This README is already detailed enough to serve as documentation!\n\n### other\n\n- [ ] It would be fun if we had some kind of a [badger](https://en.wikipedia.org/wiki/Badger) logo!\n\n## \ud83d\udcdd License\n\nCopyright \u00a9 2021 - present [Victor Miti](https://github.com/engineervix).\n\nThis project is licensed under the terms of the [BSD-3-Clause](https://github.com/engineervix/readme-coverage-badger/blob/main/LICENSE) license.\n\n---\n\n_This README was generated with \u2764\ufe0f by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n\n---\n\n# Changelog\n\nAll notable changes to this project will be documented here.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project attempts to adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n\n## [v1.0.1](https://github.com/engineervix/readme-coverage-badger/compare/v1.0.0...v1.0.1) (2024-07-05)\n\n\n### \ud83d\udc1b Bug Fixes\n\n* broken logger configuration introduced in 1.0.0 ([7e27daa](https://github.com/engineervix/readme-coverage-badger/commit/7e27daaf552e4fc4cd6a2cf7860726720dc62bea))\n\n## [v1.0.0](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.2...v1.0.0) (2024-07-05)\n\n\n### \u26a0 BREAKING CHANGES\n\n* Python <3.8 no longer supported\n\n### \u2699\ufe0f Build System\n\n* bump outdated dependencies to latest versions ([63a5f78](https://github.com/engineervix/readme-coverage-badger/commit/63a5f782de106a5358f97e1010afbcc88ccb1065))\n* update outdated pre-commit hooks ([775fe7e](https://github.com/engineervix/readme-coverage-badger/commit/775fe7e5d55685118b0d441a4c9f2c990a92b428))\n\n\n### \ud83d\ude80 Features\n\n* add support for Python 3.11, 3.12 & drop Python 3.6 and 3.7 ([e30c803](https://github.com/engineervix/readme-coverage-badger/commit/e30c8035b208f1068f763a84f7f6ff7825d71e25))\n\n\n### \ud83d\udcdd Docs\n\n* update docs ([151a20f](https://github.com/engineervix/readme-coverage-badger/commit/151a20f453dfb8d0fde103c8b172d16329e4f1ed))\n\n\n### \ud83d\udc84 Styling\n\n* update Black's target versions ([52ee283](https://github.com/engineervix/readme-coverage-badger/commit/52ee283e6b6c27022128d575505e77c2194a5232))\n\n\n### \u267b\ufe0f Code Refactoring\n\n* update logging configuration ([89c8276](https://github.com/engineervix/readme-coverage-badger/commit/89c827657372a0ecfae29a2d8585f33f33c3ecfb))\n\n\n### \ud83d\udc77 CI/CD\n\n* add manually triggered workflow ([aac0ae3](https://github.com/engineervix/readme-coverage-badger/commit/aac0ae3668cdce216d12d7dd8189b4eb1cc37dcc))\n* bump codecov/codecov-action from v2 to v4 ([fece05b](https://github.com/engineervix/readme-coverage-badger/commit/fece05bc48a6a2e022f18aaf1960eeab2f513098))\n* disable publishing to testPyPI ([ebe85af](https://github.com/engineervix/readme-coverage-badger/commit/ebe85af548d3087aae622eb49302c350b94227bb))\n* update CI to use latest actions and OSes ([f0a92d3](https://github.com/engineervix/readme-coverage-badger/commit/f0a92d3c52b6d76d578cd5b3e74c5352afb4cf3e))\n* you need an upload token from codecov.io ([806eeb9](https://github.com/engineervix/readme-coverage-badger/commit/806eeb97cd723d223afc2dc19ee669292eb70334))\n\n## [v0.1.2](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.1...v0.1.2) (2022-01-21)\n\n\n### \ud83d\udcdd Docs\n\n* **changelog:** add note on version 0.1.0 ([7e7b8a6](https://github.com/engineervix/readme-coverage-badger/commit/7e7b8a6d77c29878d9e65e366a7633d1f7a85ccf))\n* **changelog:** regenerate using [standard-version](https://github.com/conventional-changelog/standard-version) ([90da4da](https://github.com/engineervix/readme-coverage-badger/commit/90da4da6bd3440f528ed3e8f2b9d452ad7c1fb81))\n* **readme:** add a GIF to demonstrate the tool ([82afdbe](https://github.com/engineervix/readme-coverage-badger/commit/82afdbeffe125cea3ef66e84af03d1c5d0eee926))\n* **readme:** general reorganisation of the docs \u2013 centre the badges, categorize the TODOs and add some minor improvements ([d46fcbb](https://github.com/engineervix/readme-coverage-badger/commit/d46fcbb59b427700f34f9faebfdc92be28fbf61b))\n\n\n### \ud83d\udc84 Styling\n\n* **changelog:** move <hr> to the end of the file ([aa9b442](https://github.com/engineervix/readme-coverage-badger/commit/aa9b44220c757246a369a0558226ebe434daeb50))\n* update changelog configuration ([0e0fd06](https://github.com/engineervix/readme-coverage-badger/commit/0e0fd0608412665fe080adffd2c86fd3ddbe410e))\n\n\n### \u2699\ufe0f Build System\n\n* **deps-dev:** bump faker from 8.9.1 to 8.10.0 ([#3](https://github.com/engineervix/readme-coverage-badger/issues/3)) ([63c50d9](https://github.com/engineervix/readme-coverage-badger/commit/63c50d974a7ae16124d886f88525aa24ec588c98))\n* **deps-dev:** bump invoke from 1.5.0 to 1.6.0 ([#5](https://github.com/engineervix/readme-coverage-badger/issues/5)) ([f62aa4e](https://github.com/engineervix/readme-coverage-badger/commit/f62aa4e02df76def5539d8de104731904e40b9fa))\n* **deps-dev:** bump isort from 5.9.1 to 5.9.2 ([#4](https://github.com/engineervix/readme-coverage-badger/issues/4)) ([81837d2](https://github.com/engineervix/readme-coverage-badger/commit/81837d2ba942e61180f4f3c5ffed178f8e1ac7fb))\n* **deps-dev:** update outdated packages ([45bd516](https://github.com/engineervix/readme-coverage-badger/commit/45bd516bd226fb4d73c2ba0197b3a04fa0fba68e))\n* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.17.12 ([63cf405](https://github.com/engineervix/readme-coverage-badger/commit/63cf405872557b4086e5b8b9ca4dfb7acaa90646))\n* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.17.13 ([69b65cc](https://github.com/engineervix/readme-coverage-badger/commit/69b65ccae0d2767c8ddec04019a5d25b46321280))\n* **deps-dev:** update precommit hook commitizen-tools/commitizen to v2.18.0 ([50a946f](https://github.com/engineervix/readme-coverage-badger/commit/50a946ffc186ea63ed4338647e19b5c78ba03c6a))\n* **deps-dev:** update precommit hook pre-commit/mirrors-isort to v5.9.2 ([922f932](https://github.com/engineervix/readme-coverage-badger/commit/922f9326e47612a4ce600156b64cceb13babb278))\n* **deps-dev:** update precommit hook pycqa/isort to v5.9.3 ([300dd31](https://github.com/engineervix/readme-coverage-badger/commit/300dd317ea2ae8346cb2334f8453744884f58819))\n\n\n### \ud83d\udc1b Bug Fixes\n\n* enforce coverage<6 and ensure python 3.10 support ([e2c2f92](https://github.com/engineervix/readme-coverage-badger/commit/e2c2f92e5d4d2bc422d7029e2cced96083d7058a))\n\n\n### \ud83d\udc77 CI/CD\n\n* add `renovate.json` ([#6](https://github.com/engineervix/readme-coverage-badger/issues/6)) ([194b29e](https://github.com/engineervix/readme-coverage-badger/commit/194b29ea4b137774e8f1a0cb953462e8f1d2ffbb))\n* add GH action to greet first-time contributors ([8085515](https://github.com/engineervix/readme-coverage-badger/commit/80855154f24c3239485738a9204a089474bb000a))\n* add manually triggered workflow ([c8b3e66](https://github.com/engineervix/readme-coverage-badger/commit/c8b3e66e21fa857da7c72f19e0442e36d764e3a1))\n* add the lint job to python 3.8 on TRavis CI ([0d20cbf](https://github.com/engineervix/readme-coverage-badger/commit/0d20cbf9ebd244a739360aa67f8f4a172351fbef))\n* correct the Travis CI config to support PEP 517 builds ([9e476a1](https://github.com/engineervix/readme-coverage-badger/commit/9e476a1211d232516d1c90416c42142add8ab729))\n* customize renovate config to allow automatic dependency management ([8fcc766](https://github.com/engineervix/readme-coverage-badger/commit/8fcc766910feae114ebdeb7e6cc7e695e3557a3f))\n* disable publishing to testPyPI ([00c8783](https://github.com/engineervix/readme-coverage-badger/commit/00c87838a1007037bfbd7221c0d4018412fbe5a6))\n* improved release workfow through some custom hacks ([ee12b8e](https://github.com/engineervix/readme-coverage-badger/commit/ee12b8e22d2d084d0ad8f1a8a3663f4a8c62d4c5))\n* pre-commit autoupdate ([#10](https://github.com/engineervix/readme-coverage-badger/issues/10)) ([c4a52df](https://github.com/engineervix/readme-coverage-badger/commit/c4a52dffb0dbee881971935b8eb52f4fdf1fcbd6))\n* **pre-commit.ci:** pre-commit autoupdate ([#12](https://github.com/engineervix/readme-coverage-badger/issues/12)) ([94c2929](https://github.com/engineervix/readme-coverage-badger/commit/94c2929d5b3ed6b847f7092b1c15b805795d44f3))\n* remove `dependabot.yml` configuration file ([bc0568b](https://github.com/engineervix/readme-coverage-badger/commit/bc0568badcf3491c6b5fd03397abb051bf54e36b))\n* **renovate.json:** fix configuration ([#9](https://github.com/engineervix/readme-coverage-badger/issues/9)) ([14dd8b3](https://github.com/engineervix/readme-coverage-badger/commit/14dd8b360e2b759c375474e585fb917f86ddb8b6))\n* run tests on GNU/Linux, Mac OS X and Windows ([2a2b446](https://github.com/engineervix/readme-coverage-badger/commit/2a2b446ef756edc0f8ea1d6a0ee9803c77b28174))\n* run tests on Python 3.10 ([6e93962](https://github.com/engineervix/readme-coverage-badger/commit/6e9396246f40d015f854632d9304149e973ebf38))\n* switch from Travis CI to GitHub Actions ([ba1b1fb](https://github.com/engineervix/readme-coverage-badger/commit/ba1b1fb39deb71575b8e178189a509e5fde59b2c))\n* **travis:** revert to the initial setup defined in f53d6a ([4db1f32](https://github.com/engineervix/readme-coverage-badger/commit/4db1f3292329e9ea9a3c8e6c4fed59933ad54dd5))\n\n## [v0.1.1](https://github.com/engineervix/readme-coverage-badger/compare/v0.1.0...v0.1.1) (2021-07-07)\n\n\n### \ud83d\udcdd Docs\n\n* **readme:** additional badges showing PyPi download stats, supported Python versions and commit activity ([5c735b2](https://github.com/engineervix/readme-coverage-badger/commit/5c735b2a88c0423a937afb03dd900ed824e58b32))\n* **readme:** correct the Travis CI Badge URL to point to the master branch ([275443e](https://github.com/engineervix/readme-coverage-badger/commit/275443e2a3711c1d2687f08d9b14f3f191f3ac61))\n* **readme:** fix typo in opening paragraph of \"Why this Project?\" ([118f9ba](https://github.com/engineervix/readme-coverage-badger/commit/118f9ba30788cbdb0d822fdc994f033c4e67851c))\n* **readme:** minor grammar improvements ([ad63721](https://github.com/engineervix/readme-coverage-badger/commit/ad6372176f4dfb6e24921af1751bd1562fd16d8a))\n\n\n### \u2699\ufe0f Build System / Dependencies\n\n* **deps-dev:** bump commitizen from 2.17.11 to 2.17.12 ([#2](https://github.com/engineervix/readme-coverage-badger/issues/2)) ([9e769fd](https://github.com/engineervix/readme-coverage-badger/commit/9e769fdf2016b7101a13bfad1d50cd3b552aee5b))\n\n\n### \ud83d\udee0 Miscellaneous\n\n* deploy on PyPi only when you create (and push) new tags on master ([c34224f](https://github.com/engineervix/readme-coverage-badger/commit/c34224f0beb24470b75a1cc0b4f98d396849dcb9))\n* **pyproject.toml:** make isort compatible with black, just like the pre-commit configuration ([ba0a438](https://github.com/engineervix/readme-coverage-badger/commit/ba0a4380184daa33bfe63399dfe00111b4795940))\n\n\n### \ud83e\udea0 Maintenance\n\n* **travis:** replace __token__ with actual username ([87fddc2](https://github.com/engineervix/readme-coverage-badger/commit/87fddc26289c2afe05ebd04557e83c5962df40f7))\n\n\n### \ud83d\udc1b Bug Fixes\n\n* bug in `readme_location` ([df68dc2](https://github.com/engineervix/readme-coverage-badger/commit/df68dc23bde654053b82a8abf6f55f81a7a0a636))\n\n## [v0.1.0](https://github.com/engineervix/readme-coverage-badger/compare/8c618b...v0.1.0) (2021-07-06)\n\n\n### \ud83e\udea0 Maintenance\n\n* automatic deployment on PyPi ([f53d6ae](https://github.com/engineervix/readme-coverage-badger/commit/f53d6ae33dde87788215f238086de28f04958e23))\n\n\n### \ud83d\udee0 Miscellaneous\n\n* fix typo in repo name ([6d9cb11](https://github.com/engineervix/readme-coverage-badger/commit/6d9cb11ef5f6398c1ce501c5b8b2df391dfdff6f))\n* fix typos on badge URLs ([d8b32ac](https://github.com/engineervix/readme-coverage-badger/commit/d8b32acba74a282aa38877e6af93e734252492b2))\n* only install codecov on travis ([8a3bd55](https://github.com/engineervix/readme-coverage-badger/commit/8a3bd559d78ce7c810c4f3ffc5b9be5e1895e5cc))\n* remove detect-aws-credentials hook ([4b571d8](https://github.com/engineervix/readme-coverage-badger/commit/4b571d87f7eb7d15d78ade48590de0ca277a3728))\n* simplify travis setup, for now ([958aa6d](https://github.com/engineervix/readme-coverage-badger/commit/958aa6dfc6cf01a025aff05d250173b331df5e8d))\n* use focal instead of default bionic ([5116bd6](https://github.com/engineervix/readme-coverage-badger/commit/5116bd602fcf78563272d886c24dac427b704638))\n\n# BSD 3-Clause License\n\nCopyright (c) 2021 - present, Victor Miti\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": "automatically generates your project's coverage badge using the shields.io service, and then updates your README",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/engineervix/readme-coverage-badger/issues",
"Changelog": "https://github.com/engineervix/readme-coverage-badger/blob/master/CHANGELOG.md",
"Documentation": "https://github.com/engineervix/readme-coverage-badger/blob/master/README.md",
"Download": "https://pypi.org/project/readme-coverage-badger/#files",
"Homepage": "https://github.com/engineervix/readme-coverage-badger/",
"Source": "https://github.com/engineervix/readme-coverage-badger/"
},
"split_keywords": [
"coverage",
"badge",
"shield",
"readme"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52721e4a0466af47b6c292ee85bf3d21bac842074d56b0380431cc5552fb49b9",
"md5": "cb72c4f7297578dfb58e4e69e12b431b",
"sha256": "31f7e20ef2f59c3ad2f45ab152caf8b270cec503c3345d0a29fac92f31e6c646"
},
"downloads": -1,
"filename": "readme_coverage_badger-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb72c4f7297578dfb58e4e69e12b431b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16212,
"upload_time": "2024-07-05T01:03:32",
"upload_time_iso_8601": "2024-07-05T01:03:32.040795Z",
"url": "https://files.pythonhosted.org/packages/52/72/1e4a0466af47b6c292ee85bf3d21bac842074d56b0380431cc5552fb49b9/readme_coverage_badger-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0c89ad9e466878cd009df78845cd178d4353866260cd2864475947434c402c84",
"md5": "3ce19ca77e5bf5fdb48d49ede6bf9390",
"sha256": "a025df71f794dbe45ec241950c14271ad4c46f5bd316f0356bdc352ea19af2b5"
},
"downloads": -1,
"filename": "readme_coverage_badger-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "3ce19ca77e5bf5fdb48d49ede6bf9390",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31220,
"upload_time": "2024-07-05T01:03:33",
"upload_time_iso_8601": "2024-07-05T01:03:33.477061Z",
"url": "https://files.pythonhosted.org/packages/0c/89/ad9e466878cd009df78845cd178d4353866260cd2864475947434c402c84/readme_coverage_badger-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-05 01:03:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "engineervix",
"github_project": "readme-coverage-badger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "readme-coverage-badger"
}
JSON
