Skip to content

Commit 25f2758

Browse files
authored
Merge pull request #15 from boromir674/release
Cookiecutter Python Package v0.9.1 Release
2 parents 0cf5a86 + c5562cc commit 25f2758

File tree

4 files changed

+58
-16
lines changed

4 files changed

+58
-16
lines changed

CHANGELOG.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
Changelog
22
=========
33

4+
0.9.1 (2022-05-09)
5+
------------------
6+
7+
Added some "juicy" 'code badges' in README, to demonstrate the status reported by
8+
the various CI services that this github repository integrates with.
9+
10+
documentation
11+
^^^^^^^^^^^^^
12+
- add badges demonstrating code coverage percentage & code quality reported CI services
13+
14+
415
0.9.0 (2022-05-09)
516
------------------
617

README.rst

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Python Package (pypi) Cookiecutter, with emphasis on CI/CD and automation.
55

66
.. start-badges
77
8-
| |build| |docs| |release_version| |wheel| |supported_versions| |commits_since_specific_tag_on_master| |commits_since_latest_github_release| |ossf|
8+
| |build| |docs| |coverage| |ossf| |maintainability| |better_code_hub| |tech-debt|
9+
| |release_version| |wheel| |supported_versions| |gh-lic| |commits_since_specific_tag_on_master| |commits_since_latest_github_release|
910
1011
|
1112
| **Source:** https://github.com/boromir674/cookiecutter-python-package
@@ -148,6 +149,7 @@ For more complex use cases, you can modify the Template and also leverage all of
148149
.. _black: https://black.readthedocs.io/en/stable/
149150

150151

152+
151153
.. BADGE ALIASES
152154
153155
.. Test Workflow Status on Github Actions for specific branch <branch>
@@ -156,12 +158,20 @@ For more complex use cases, you can modify the Template and also leverage all of
156158
:alt: GitHub Workflow Status (branch)
157159
:target: https://github.com/boromir674/cookiecutter-python-package/actions/workflows/test.yaml?query=branch%3Amaster
158160

159-
.. above url to workflow runs, filtered by the specified branch
161+
.. Code Coverage
162+
.. Codecov CI
163+
164+
.. |coverage| image:: https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov
165+
:alt: Codecov
166+
:target: https://app.codecov.io/gh/boromir674/cookiecutter-python-package
160167

161168
.. |docs| image:: https://img.shields.io/readthedocs/python-package-generator/master?logo=readthedocs&logoColor=lightblue
162169
:alt: Read the Docs (version)
163170
:target: https://python-package-generator.readthedocs.io/en/master/
164171

172+
173+
.. PyPI
174+
165175
.. |release_version| image:: https://img.shields.io/pypi/v/cookiecutter_python
166176
:alt: Production Version
167177
:target: https://pypi.org/project/cookiecutter-python/
@@ -174,29 +184,50 @@ For more complex use cases, you can modify the Template and also leverage all of
174184
:alt: Supported Python versions
175185
:target: https://pypi.org/project/cookiecutter-python
176186

177-
.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v0.9.0/master?color=blue&logo=github
187+
188+
.. Github Releases & Tags
189+
190+
.. |commits_since_specific_tag_on_master| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/v0.9.1/master?color=blue&logo=github
178191
:alt: GitHub commits since tagged version (branch)
179-
:target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.9.0..master
192+
:target: https://github.com/boromir674/cookiecutter-python-package/compare/v0.9.1..master
180193

181194
.. |commits_since_latest_github_release| image:: https://img.shields.io/github/commits-since/boromir674/cookiecutter-python-package/latest?color=blue&logo=semver&sort=semver
182195
:alt: GitHub commits since latest release (by SemVer)
183196

184197

185-
.. |codecov| image:: https://img.shields.io/codecov/c/github/boromir674/cookiecutter-python-package/master?logo=codecov
186-
:alt: Codecov
187-
:target: https://app.codecov.io/gh/boromir674/cookiecutter-python-package
188-
189-
.. |better_code_hub| image:: https://bettercodehub.com/edge/badge/boromir674/cookiecutter-python-package?branch=master
190-
:alt: Better Code Hub
191-
:target: https://bettercodehub.com/
198+
.. LICENSE (eg AGPL, MIT)
199+
.. Github License
192200
193-
194-
.. Github License (eg AGPL, MIT)
195201
.. |gh-lic| image:: https://img.shields.io/github/license/boromir674/cookiecutter-python-package
196202
:alt: GitHub
197203
:target: https://github.com/boromir674/cookiecutter-python-package/blob/master/LICENSE
198204

199205

206+
.. Free/Libre Open Source Software
207+
.. Open Source Software Best Practices
208+
200209
.. |ossf| image:: https://bestpractices.coreinfrastructure.org/projects/5988/badge
201210
:alt: OpenSSF
202211
:target: https://bestpractices.coreinfrastructure.org/en/projects/5988
212+
213+
214+
.. CODE QUALITY
215+
216+
.. Better Code Hub
217+
.. Software Design Patterns
218+
219+
.. |better_code_hub| image:: https://bettercodehub.com/edge/badge/boromir674/cookiecutter-python-package?branch=master
220+
:alt: Better Code Hub
221+
:target: https://bettercodehub.com/
222+
223+
224+
.. Code Climate CI
225+
.. Code maintainability & Technical Debt
226+
227+
.. |maintainability| image:: https://api.codeclimate.com/v1/badges/1d347d7dfaa134fd944e/maintainability
228+
:alt: Maintainability
229+
:target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability
230+
231+
.. |tech-debt| image:: https://img.shields.io/codeclimate/tech-debt/boromir674/cookiecutter-python-package
232+
:alt: Code Climate technical debt
233+
:target: https://codeclimate.com/github/boromir674/cookiecutter-python-package/maintainability

setup.cfg

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[metadata]
22
## Setuptools specific information
33
name = cookiecutter_python
4-
version = 0.9.0
4+
version = 0.9.1
55
# renders on pypi as subtitle
66
description = Yet another modern Python Package (pypi) with emphasis in CI/CD and automation
77
long_description = file: README.rst
@@ -15,7 +15,7 @@ author_email = k.lampridis@hotmail.com
1515
# represents the web home page of the project
1616
url = https://github.com/boromir674/cookiecutter-python-package
1717

18-
download_url = https://github.com/boromir674/cookiecutter-python-package/archive/v0.9.0.tar.gz
18+
download_url = https://github.com/boromir674/cookiecutter-python-package/archive/v0.9.1.tar.gz
1919

2020
## PyPi specific information
2121
project_urls =
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
__version__ = '0.9.0'
1+
__version__ = '0.9.1'

0 commit comments

Comments
 (0)