Skip to content

Commit 2260249

Browse files
juftinjuftin
committed
📝 badges
1 parent d736aad commit 2260249

File tree

7 files changed

+59
-42
lines changed

7 files changed

+59
-42
lines changed

‎tests/example-project/README.md‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# example-project
1+
<h1 align="center">example-project</h1>
22

3+
<p align="center">
34
Brief description of the project
5+
</p>
46

5-
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
7-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8-
[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev)
7+
<p align="center">
8+
<a href="https://juftin.github.io/example-project/"><img src="https://img.shields.io/static/v1?message=docs&color=526CFE&logo=Material+for+MkDocs&logoColor=FFFFFF&label=" alt="docs"></a>
9+
<a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch project"></a>
10+
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
11+
<a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit" alt="pre-commit"></a>
12+
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>
13+
<a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg" alt="Gitmoji"></a>
14+
</p>
915

1016
#### Check Out the [Docs](https://juftin.github.io/example-project/)
1117

1218
#### Looking to contribute? See the [Contributing Guide](https://juftin.github.io/example-project/contributing)
1319

1420
#### See the [Changelog](https://github.com/juftin/example-project/releases)
15-
16-
---
17-
18-
---
19-
20-
<br/>
21-
22-
<p align="center"><a href="https://github.com/juftin"><img src="https://raw.githubusercontent.com/juftin/juftin/main/static/juftin.png" width="120" height="120" alt="logo"></p>

‎tests/example-project/docs/index.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# example-project
1+
<h1 align="center">example-project</h1>
22

3+
<p align="center">
34
Brief description of the project
5+
</p>
46

5-
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
7-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8-
[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev)
7+
<p align="center">
8+
<a href="https://juftin.github.io/example-project/"><img src="https://img.shields.io/static/v1?message=docs&color=526CFE&logo=Material+for+MkDocs&logoColor=FFFFFF&label=" alt="docs"></a>
9+
<a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch project"></a>
10+
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
11+
<a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit" alt="pre-commit"></a>
12+
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>
13+
<a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg" alt="Gitmoji"></a>
14+
</p>

‎tests/example-project/mkdocs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
site_name: example-project
44
nav:
5-
- index.md
5+
- Home 🏠: index.md
66
- Contributing 🤝: contributing.md
77
theme:
88
favicon: https://juftin.com/favicon.ico

‎tests/test_cookiecutter.py‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def cookiecutter_dir() -> pathlib.Path:
2828
"build_docker_image": True,
2929
"publish_to_pypi": True,
3030
"publish_to_docker_hub": True,
31-
}
31+
},
3232
)
3333
return output_repo
3434

@@ -37,7 +37,9 @@ def test_cookiecutter_dir(cookiecutter_dir: pathlib.Path) -> None:
3737
"""
3838
Test file content equality
3939
"""
40-
all_generated_files = list(cookiecutter_dir.rglob("*"))
40+
all_generated_files = filter(
41+
lambda f: "__pycache__" not in f.parts, cookiecutter_dir.rglob("*")
42+
)
4143
test_files = pathlib.Path(__file__).parent / "example-project"
4244
file_counter = 0
4345
for generated_file in all_generated_files:
@@ -61,6 +63,13 @@ def test_same_files(cookiecutter_dir: pathlib.Path) -> None:
6163
Test file name / number equality
6264
"""
6365
test_dir = pathlib.Path(__file__).parent / "example-project"
64-
all_generated_files = set(f.relative_to(cookiecutter_dir) for f in cookiecutter_dir.rglob("*"))
65-
all_test_files = set(f.relative_to(test_dir) for f in test_dir.rglob("*"))
66+
all_generated_files = set(
67+
f.relative_to(cookiecutter_dir)
68+
for f in cookiecutter_dir.rglob("*")
69+
if "__pycache__" not in f.parts
70+
)
71+
all_test_files = set(
72+
f.relative_to(test_dir) for f in test_dir.rglob("*") if "__pycache__" not in f.parts
73+
)
74+
6675
assert all_generated_files == all_test_files

‎{{cookiecutter.repo_name}}/README.md‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
# {{ cookiecutter.project_name }}
1+
<h1 align="center">{{ cookiecutter.project_name }}</h1>
22

3+
<p align="center">
34
{{ cookiecutter.project_short_description }}
5+
</p>
46

5-
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
7-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8-
[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev)
7+
<p align="center">
8+
<a href="https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.repo_name }}/"><img src="https://img.shields.io/static/v1?message=docs&color=526CFE&logo=Material+for+MkDocs&logoColor=FFFFFF&label=" alt="docs"></a>
9+
<a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch project"></a>
10+
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
11+
<a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit" alt="pre-commit"></a>
12+
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>
13+
<a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg" alt="Gitmoji"></a>
14+
</p>
915

1016
#### Check Out the [Docs](https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.repo_name }}/)
1117

1218
#### Looking to contribute? See the [Contributing Guide](https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.repo_name }}/contributing)
1319

1420
#### See the [Changelog](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}/releases)
15-
16-
---
17-
18-
---
19-
20-
<br/>
21-
22-
<p align="center"><a href="https://github.com/{{ cookiecutter.github_username }}"><img src="{{ cookiecutter.logo_url }}" width="120" height="120" alt="logo"></p>

‎{{cookiecutter.repo_name}}/docs/index.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# {{ cookiecutter.project_name }}
1+
<h1 align="center">{{ cookiecutter.project_name }}</h1>
22

3+
<p align="center">
34
{{ cookiecutter.project_short_description }}
5+
</p>
46

5-
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
6-
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
7-
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
8-
[![Gitmoji](https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg)](https://gitmoji.dev)
7+
<p align="center">
8+
<a href="https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.repo_name }}/"><img src="https://img.shields.io/static/v1?message=docs&color=526CFE&logo=Material+for+MkDocs&logoColor=FFFFFF&label=" alt="docs"></a>
9+
<a href="https://github.com/pypa/hatch"><img src="https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg" alt="Hatch project"></a>
10+
<a href="https://github.com/astral-sh/ruff"><img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff"></a>
11+
<a href="https://github.com/pre-commit/pre-commit"><img src="https://img.shields.io/badge/pre--commit-enabled-lightgreen?logo=pre-commit" alt="pre-commit"></a>
12+
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release"></a>
13+
<a href="https://gitmoji.dev"><img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg" alt="Gitmoji"></a>
14+
</p>

‎{{cookiecutter.repo_name}}/mkdocs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
site_name: {{ cookiecutter.friendly_name }}
44
nav:
5-
- index.md
5+
- Home 🏠: index.md
66
- Contributing 🤝: contributing.md
77
theme:
88
favicon: {{ cookiecutter.favicon }}

0 commit comments

Comments
 (0)