From 9e5fcb7f5107dcc3df52552d1826052e385e76a5 Mon Sep 17 00:00:00 2001 From: Tom Cobb Date: Fri, 9 Feb 2024 15:52:12 +0000 Subject: [PATCH 1/2] Fix codecov badge in readme --- template/README.md.jinja | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/template/README.md.jinja b/template/README.md.jinja index 88d8ac040..e73ce3d9b 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -1,5 +1,5 @@ [![CI]({{repo_url}}/actions/workflows/ci.yml/badge.svg)]({{repo_url}}/actions/workflows/ci.yml) -[![Coverage](https://codecov.io/gh/{{github_org}}/{{repo_name}}/branch/master/graph/badge.svg)](https://codecov.io/gh/{{github_org}}/{{repo_name}}) +[![Coverage](https://codecov.io/gh/{{github_org}}/{{repo_name}}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{github_org}}/{{repo_name}}) [![PyPI](https://img.shields.io/pypi/v/{{pypi_name}}.svg)](https://pypi.org/project/{{pypi_name}}) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) From 3579ec9584302e10481393c18d9db5e3cb07b105 Mon Sep 17 00:00:00 2001 From: Tom Cobb Date: Fri, 9 Feb 2024 16:25:52 +0000 Subject: [PATCH 2/2] Correct README for pypi name and codecov badge --- template/README.md.jinja | 4 ++-- .../tutorials/installation.md.jinja | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/template/README.md.jinja b/template/README.md.jinja index e73ce3d9b..001757171 100644 --- a/template/README.md.jinja +++ b/template/README.md.jinja @@ -1,6 +1,6 @@ [![CI]({{repo_url}}/actions/workflows/ci.yml/badge.svg)]({{repo_url}}/actions/workflows/ci.yml) [![Coverage](https://codecov.io/gh/{{github_org}}/{{repo_name}}/branch/main/graph/badge.svg)](https://codecov.io/gh/{{github_org}}/{{repo_name}}) -[![PyPI](https://img.shields.io/pypi/v/{{pypi_name}}.svg)](https://pypi.org/project/{{pypi_name}}) +[![PyPI](https://img.shields.io/pypi/v/{{distribution_name}}.svg)](https://pypi.org/project/{{distribution_name}}) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) # {{ package_name }} @@ -10,7 +10,7 @@ how it does it, and why people should use it. Source | <{{repo_url}}> :---: | :---: -PyPI | `pip install {{pypi_name}}` +PyPI | `pip install {{distribution_name}}` {% if sphinx %}Documentation | <{{docs_url}}>{% endif %} Releases | <{{repo_url}}/releases> diff --git a/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja b/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja index 5d05aadc3..6c054c9a7 100644 --- a/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja +++ b/template/{% if sphinx %}docs{% endif %}/tutorials/installation.md.jinja @@ -24,7 +24,7 @@ $ source /path/to/venv/bin/activate You can now use `pip` to install the library and its dependencies: ``` -$ python3 -m pip install {{pypi_name}} +$ python3 -m pip install {{distribution_name}} ``` If you require a feature that is not currently released you can also install