Skip to content

Commit 774048c

Browse files
liblafliblaf
committed
docs: update README files with modern social badges and consistent formatting
Replace custom banner images with socialify.git.ci badges for better visual consistency and maintainability. Simplify feature descriptions to focus on core project value. Update contributor badges to use contrib.nn.ci service for accurate contributor counts. Add dynamic sections for project links using tangerine templates. These changes improve the professional appearance of the documentation while making it easier to maintain with automated badge generation and template-based content sections.
1 parent db2f421 commit 774048c

2 files changed

Lines changed: 37 additions & 137 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,23 @@
11
<div align="center"><a name="readme-top"></a>
22

3-
<img height="120" src="https://raw.githubusercontent.com/copier-org/copier/refs/heads/master/img/logo.svg" />
4-
<img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg" />
5-
<img height="120" src="https://api.iconify.design/devicon/python.svg" />
3+
![copier-python](https://socialify.git.ci/liblaf/copier-python/image?custom_language=Python&description=1&forks=1&issues=1&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2Fcopier-org%2Fcopier%2Frefs%2Fheads%2Fmaster%2Fimg%2Flogo.svg&name=1&owner=1&pattern=Transparent&pulls=1&stargazers=1&theme=Auto)
64

7-
<h1>Copier Python</h1>
8-
9-
This repository provides a comprehensive Python project template with automated workflows for CI/CD, dependency management, and code quality enforcement. It features advanced tools like MegaLinter for static analysis, Copier for template updates, and Pixi for package management, making it ideal for building maintainable Python projects with minimal setup.
10-
11-
[![Made with Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier) <br />
12-
[![contributors](https://img.shields.io/github/contributors/liblaf/copier-python)](https://github.com/liblaf/copier-python/graphs/contributors)
13-
[![forks](https://img.shields.io/github/forks/liblaf/copier-python)](https://github.com/liblaf/copier-python/forks)
14-
[![stars](https://img.shields.io/github/stars/liblaf/copier-python)](https://github.com/liblaf/copier-python/stargazers)
15-
[![issues](https://img.shields.io/github/issues/liblaf/copier-python)](https://github.com/liblaf/copier-python/issues)
16-
[![license](https://img.shields.io/github/license/liblaf/copier-python)](https://github.com/liblaf/copier-python/blob/main/LICENSE)
5+
[![Made with Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-black.json)](https://github.com/copier-org/copier)
176

187
[Changelog](https://github.com/liblaf/copier-python/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/liblaf/copier-python/issues) · [Request Feature](https://github.com/liblaf/copier-python/issues)
198

20-
![banner](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
9+
![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)
2110

2211
</div>
2312

2413
## ✨ Features
2514

26-
- 🤖 **Automated Workflows:** Comprehensive GitHub Actions workflows for automated PR management, repository maintenance, and CI/CD pipelines;
27-
- 🧹 **Code Quality Assurance:** Integrated MegaLinter for consistent code quality checks and automatic fixes across multiple languages and formats;
28-
- 🧩 **Template-Driven Development:** Built with Copier templates for easy project scaffolding and consistent project structure across repositories;
29-
- 📦 **Package Management:** Supports both Pixi and UV package managers for flexible dependency management and environment setup;
30-
- 🛠️ **Build & Release Automation:** Automated build, test, and release processes with pre-release and production release workflows;
31-
- 🔒 **Security-First Approach:** Default workflow permissions and repository settings configured for secure development practices;
32-
- 📚 **Documentation Ready:** Pre-configured documentation structure and tools for maintaining clear project documentation;
33-
- 🐍 **Python-Centric:** Optimized for Python development with pre-configured linting, type checking, and build tools;
34-
- 🔄 **Continuous Updates:** Automated repository updates through Copier and Renovate for keeping dependencies and templates up-to-date;
35-
- 🎨 **VS Code Integration:** Pre-configured VS Code settings for Python development with optimized workspace configurations.
36-
37-
<div align="right">
38-
39-
[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
40-
41-
</div>
15+
- 🚀 **Quick Setup:** Get started instantly with a modern Python project template that includes pre-configured tools and workflows;
16+
- 🛠️ **Comprehensive Tooling:** Integrated with Ruff, Pyright, and pytest for linting, type checking, and testing out of the box;
17+
- 📚 **Beautiful Documentation:** Automatically generated API docs with MkDocs and Material theme, ready for GitHub Pages deployment;
18+
- ⚡ **Performance Ready:** Built-in benchmarking support with CodSpeed for tracking performance regressions;
19+
- 🔄 **Automated Releases:** CI/CD workflows handle testing, building, and publishing to PyPI on tag creation;
20+
- 🎯 **Type Safe:** Full type hint coverage with Pyright configuration and stub files for better development experience;
4221

4322
## 📦 Installation
4423

@@ -48,12 +27,6 @@ To install `gh:liblaf/copier-python`, run the following command:
4827
copier copy --trust gh:liblaf/copier-python .
4928
```
5029

51-
<div align="right">
52-
53-
[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
54-
55-
</div>
56-
5730
## ⌨️ Local Development
5831

5932
You can use Github Codespaces for online development:
@@ -67,48 +40,28 @@ git clone https://github.com/liblaf/copier-python.git
6740
cd copier-python
6841
```
6942

70-
<div align="right">
71-
72-
[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
73-
74-
</div>
75-
7643
## 🤝 Contributing
7744

7845
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/liblaf/copier-python/issues) to get stuck in to show us what you're made of.
7946

8047
[![PR Welcome](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/liblaf/copier-python/pulls)
8148

82-
[![Contributors](https://contrib.rocks/image?repo=liblaf%2Fcopier-python)](https://github.com/liblaf/copier-python/graphs/contributors)
83-
84-
<div align="right">
85-
86-
[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
87-
88-
</div>
89-
90-
## 🔗 Links
91-
92-
### More Copier Templates
93-
94-
- **[Copier Python](https://github.com/liblaf/copier-python)** - 🚀 A comprehensive Python project template with automated workflows, CI/CD integration, and modern development tools. Features include MegaLinter for code quality, Copier for template updates, and Renovate for dependency management. Perfect for building scalable Python packages with best practices! 🐍✨
95-
- **[Copier Release](https://github.com/liblaf/copier-release)** - 🚀 Automated GitHub Repository Management Toolkit: A comprehensive set of workflows and templates for automating repository maintenance, PR management, and release processes. Includes Copier updates, MegaLinter integration, and Release Please automation. Perfect for maintaining clean, consistent, and efficient GitHub repositories! 🛠️✨
96-
- **[Copier Share](https://github.com/liblaf/copier-share)** - 🤖✨ A comprehensive GitHub repository template with automated workflows for PR management, repository maintenance, and code quality checks. Features include auto-merging PRs, Copier updates, label synchronization, and MegaLinter integration for consistent code standards. Perfect for maintaining clean, efficient, and well-organized repositories! 🚀🔧
97-
- **[Copier Typescript](https://github.com/liblaf/copier-typescript)** - 🚀 A robust TypeScript project template with automated workflows, CI/CD pipelines, and comprehensive linting. Features include auto-PR management, copier updates, and MegaLinter integration for code quality. Perfect for scalable, maintainable, and efficient TypeScript projects! 🛠️✨
49+
[![Contributors](https://contrib.nn.ci/api?repo=liblaf/copier-python)](https://github.com/liblaf/copier-python/graphs/contributors)
9850

99-
### Credits
51+
## 🔗 More Copier Templates
10052

101-
- **Copier** - <https://github.com/copier-org/copier>
53+
<!-- tangerine-start: projects/copier.md -->
10254

103-
<div align="right">
104-
105-
[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
106-
107-
</div>
55+
- **[Shared](https://github.com/liblaf/copier-shared)** - ✨ Automated code quality and maintenance for your projects: A Copier template with pre-commit hooks, MegaLinter, and auto-update workflows.
56+
- **[Release](https://github.com/liblaf/copier-release)** - 🚀 Automated release management with Copier and Release Please
57+
- **[Python](https://github.com/liblaf/copier-python)** - 🐍 A modern Copier template for Python projects. Pre-configured with mise, ruff, pytest, mkdocs, and GitHub Actions workflows for seamless development.
58+
- **[Rust](https://github.com/liblaf/copier-rust)** - 🦀 Copier template for Rust projects with cross-compilation, CI/CD, and release automation
59+
- **[TypeScript](https://github.com/liblaf/copier-typescript)** - 🚀 Kickstart your TypeScript project with modern tools like Bun, Biome, and automated CI/CD workflows.
60+
<!-- tangerine-end -->
10861

10962
---
11063

11164
#### 📝 License
11265

11366
Copyright © 2024 [liblaf](https://github.com/liblaf). <br />
114-
This project is [MIT](./LICENSE) licensed.
67+
This project is [MIT](https://github.com/liblaf/copier-python/blob/main/LICENSE) licensed.

‎template/README.md.jinja‎

Lines changed: 18 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -3,114 +3,61 @@
33
<div align="center" markdown>
44
<a name="readme-top"></a>
55

6-
<img height="160" src="https://api.iconify.design/logos/python.svg" />
6+
![{{github_repo}}](https://socialify.git.ci/{{github_user}}/{{github_repo}}/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pattern=Transparent&pulls=1&stargazers=1&theme=Auto)
77

8-
# {{ project_name }}
9-
10-
TODO: DESCRIPTION <br />
11-
[**Explore the docs »**](https://{{ github_user }}.github.io/{{ github_repo }}/)
12-
13-
<!-- tangerine-start: badges/python.md.jinja -->
14-
15-
[![Codecov](https://img.shields.io/codecov/c/github/{{ github_user }}/{{ github_repo }}?logo=Codecov&label=Coverage)](https://codecov.io/gh/{{ github_user }}/{{ github_repo }})
16-
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/{{ github_user }}/{{ github_repo }}/test.yaml?logo=GitHub%20Actions&label=Test)](https://github.com/{{ github_user }}/{{ github_repo }}/actions/workflows/test.yaml)
17-
[![Lines of Code](https://tokei.rs/b1/github.com/{{ github_user }}/{{ github_repo }}?category=code&label=Lines%20of%20Code&style=flat)](https://github.com/{{ github_user }}/{{ github_repo }})
18-
<br />
19-
[![PyPI - Downloads](https://img.shields.io/pypi/dm/{{ package_name }}?logo=PyPI&label=Downloads)](https://pypi.org/project/{{ package_name }})
20-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/{{ package_name }}?logo=Python&label=Python)](https://pypi.org/project/{{ package_name }})
21-
[![PyPI - Version](https://img.shields.io/pypi/v/{{ package_name }}?logo=PyPI&label=PyPI)](https://pypi.org/project/{{ package_name }})
22-
<br />
23-
[![GitHub Contributors](https://img.shields.io/github/contributors/{{ github_user }}/{{ github_repo }}?logo=GitHub&label=Contributors)](https://github.com/{{ github_user }}/{{ github_repo }}/graphs/contributors)
24-
[![GitHub Issues](https://img.shields.io/github/issues/{{ github_user }}/{{ github_repo }}?logo=GitHub&label=Issues)](https://github.com/{{ github_user }}/{{ github_repo }}/issues)
25-
[![GitHub License](https://img.shields.io/github/license/{{ github_user }}/{{ github_repo }}?label=License)](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/LICENSE)
26-
[![GitHub Forks](https://img.shields.io/github/forks/{{ github_user }}/{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/forks)
27-
[![GitHub Repo Stars](https://img.shields.io/github/stars/{{ github_user }}/{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/stargazers)
8+
**[Explore the docs »](https://{{github_user}}.github.io/{{github_repo}}/)**
289

10+
<!-- tangerine-start: badges/python.md -->
2911
<!-- tangerine-end -->
3012

31-
[Changelog](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/{{ github_user }}/{{ github_repo }}/issues) · [Request Feature](https://github.com/{{ github_user}}/{{ github_repo }}/issues)
13+
[Changelog](https://github.com/{{github_user}}/{{github_repo}}/blob/main/CHANGELOG.md) · [Report Bug](https://github.com/{{github_user}}/{{github_repo}}/issues) · [Request Feature](https://github.com/{{github_user}}/{{github_repo}}/issues)
3214

3315
![](https://cdn.jsdelivr.net/gh/andreasbm/readme/assets/lines/rainbow.png)
3416

3517
</div>
3618

3719
## ✨ Features
3820

39-
- [x] ✨ **TODO:** FEATURES;
40-
41-
<div align="right" markdown>
42-
43-
[![](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
44-
45-
</div>
21+
- ✨ **TODO:** FEATURES;
4622

4723
## 📦 Installation
4824

4925
To install `{{ package_name }}`, run the following command:
5026

5127
```bash
52-
$ uv add {{ package_name }}
28+
uv add {{ package_name }}
5329
```
5430

55-
<div align="right" markdown>
56-
57-
[![](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
58-
59-
</div>
60-
6131
## ⌨️ Local Development
6232

6333
You can use Github Codespaces for online development:
6434

65-
[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{ github_user }}/{{ github_repo }})
35+
[![](https://github.com/codespaces/badge.svg)](https://codespaces.new/{{github_user}}/{{github_repo}})
6636

6737
Or clone it for local development:
6838

6939
```bash
70-
$ gh repo clone {{ github_user }}/{{ github_repo }}
71-
$ cd {{ github_repo }}
72-
$ mise run test
40+
gh repo clone {{github_user}}/{{github_repo}}
41+
cd {{github_repo}}
42+
mise run install
7343
```
7444

75-
<div align="right" markdown>
76-
77-
[![](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
78-
79-
</div>
80-
8145
## 🤝 Contributing
8246

83-
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/{{ github_user }}/{{ github_repo }}/issues) to get stuck in to show us what you're made of.
84-
85-
[![](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/{{ github_user }}/{{ github_repo }}/pulls)
86-
87-
[![](https://contrib.rocks/image?repo={{ github_user }}%2F{{ github_repo }})](https://github.com/{{ github_user }}/{{ github_repo }}/graphs/contributors)
88-
89-
<div align="right" markdown>
90-
91-
[![](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
92-
93-
</div>
47+
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues](https://github.com/{{github_user}}/{{github_repo}}/issues) to get stuck in to show us what you're made of.
9448

95-
## 🔗 Links
49+
[![PR Welcome](https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge)](https://github.com/{{github_user}}/{{github_repo}}/pulls)
9650

97-
### More Projects
51+
[![Contributors](https://contrib.nn.ci/api?repo={{github_user}}/{{github_repo}})](https://github.com/{{github_user}}/{{github_repo}}/graphs/contributors)
9852

99-
- **[🍇 Grapes](https://github.com/liblaf/grapes)** - Powerful Python utilities for logging, timing, and more, making development smoother!
53+
## 🔗 More Projects
10054

101-
### Credits
102-
103-
- **Python** - <https://www.python.org/>
104-
105-
<div align="right" markdown>
106-
107-
[![](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)
108-
109-
</div>
55+
<!-- tangerine-start: projects/fruits.md -->
56+
<!-- tangerine-end -->
11057

11158
---
11259

11360
#### 📝 License
11461

115-
Copyright © {{ "%Y" | strftime }} [{{ author_name }}](https://github.com/{{ github_user }}). <br />
116-
This project is [MIT](https://github.com/{{ github_user }}/{{ github_repo }}/blob/main/LICENSE) licensed.
62+
Copyright © {{ "%Y" | strftime }} [{{ author_name }}](https://github.com/{{github_user}}). <br />
63+
This project is [{{ license }}](https://github.com/{{github_user}}/{{github_repo}}/blob/main/LICENSE) licensed.

0 commit comments

Comments
 (0)