An open API service indexing awesome lists of open source software.

https://github.com/liblaf/copier-python

๐Ÿ› ๏ธ A comprehensive Python project template with CI/CD and package management
https://github.com/liblaf/copier-python

automation code-quality continuous-integration copier copier-template github-actions jinja package-management python repository-structure template

Last synced: 3 months ago
JSON representation

๐Ÿ› ๏ธ A comprehensive Python project template with CI/CD and package management

Awesome Lists containing this project

README

        




Copier Python

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.

[![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)

[![contributors](https://img.shields.io/github/contributors/liblaf/copier-python)](https://github.com/liblaf/copier-python/graphs/contributors)
[![forks](https://img.shields.io/github/forks/liblaf/copier-python)](https://github.com/liblaf/copier-python/forks)
[![stars](https://img.shields.io/github/stars/liblaf/copier-python)](https://github.com/liblaf/copier-python/stargazers)
[![issues](https://img.shields.io/github/issues/liblaf/copier-python)](https://github.com/liblaf/copier-python/issues)
[![license](https://img.shields.io/github/license/liblaf/copier-python)](https://github.com/liblaf/copier-python/blob/main/LICENSE)

[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)

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

## โœจ Features

- ๐Ÿค– **Automated Workflows:** Comprehensive GitHub Actions workflows for automated PR management, repository maintenance, and CI/CD pipelines;
- ๐Ÿงน **Code Quality Assurance:** Integrated MegaLinter for consistent code quality checks and automatic fixes across multiple languages and formats;
- ๐Ÿงฉ **Template-Driven Development:** Built with Copier templates for easy project scaffolding and consistent project structure across repositories;
- ๐Ÿ“ฆ **Package Management:** Supports both Pixi and UV package managers for flexible dependency management and environment setup;
- ๐Ÿ› ๏ธ **Build & Release Automation:** Automated build, test, and release processes with pre-release and production release workflows;
- ๐Ÿ”’ **Security-First Approach:** Default workflow permissions and repository settings configured for secure development practices;
- ๐Ÿ“š **Documentation Ready:** Pre-configured documentation structure and tools for maintaining clear project documentation;
- ๐Ÿ **Python-Centric:** Optimized for Python development with pre-configured linting, type checking, and build tools;
- ๐Ÿ”„ **Continuous Updates:** Automated repository updates through Copier and Renovate for keeping dependencies and templates up-to-date;
- ๐ŸŽจ **VS Code Integration:** Pre-configured VS Code settings for Python development with optimized workspace configurations.

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿ“ฆ Installation

To install `gh:liblaf/copier-python`, run the following command:

```bash
$ copier copy --trust gh:liblaf/copier-python .
```

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## โŒจ๏ธ Local Development

You can use Github Codespaces for online development:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/liblaf/copier-python)

Or clone it for local development:

```bash
$ git clone https://github.com/liblaf/copier-python.git
$ cd copier-python
```

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿค Contributing

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.

[![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)

[![Contributors](https://contrib.rocks/image?repo=liblaf%2Fcopier-python)](https://github.com/liblaf/copier-python/graphs/contributors)

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

## ๐Ÿ”— Links

### More Copier Templates

- **[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! ๐Ÿโœจ
- **[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! ๐Ÿ› ๏ธโœจ
- **[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! ๐Ÿš€๐Ÿ”ง
- **[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! ๐Ÿ› ๏ธโœจ

### Credits

- **Copier** -

[![BACK TO TOP](https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square)](#readme-top)

---

#### ๐Ÿ“ License

Copyright ยฉ 2024 [liblaf](https://github.com/liblaf).

This project is [MIT](./LICENSE) licensed.