diff --git a/README.md b/README.md index d5157b86..c7dd563f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Serious Scaffold Python -An evolving Python project template that covers the full development lifecycle. +A Python Project Template for Long-Term Maintainability. [![CI](https://github.com/serious-scaffold/ss-python/actions/workflows/ci.yml/badge.svg)](https://github.com/serious-scaffold/ss-python/actions/workflows/ci.yml) [![CommitLint](https://github.com/serious-scaffold/ss-python/actions/workflows/commitlint.yml/badge.svg)](https://github.com/serious-scaffold/ss-python/actions/workflows/commitlint.yml) @@ -31,7 +31,7 @@ An evolving Python project template that covers the full development lifecycle. [![Serious Scaffold Python](https://serious-scaffold.github.io/ss-python/_static/images/logo.svg)](https://github.com/serious-scaffold/ss-python) -Setting up a project often involves more than just establishing a basic project structure. It involves tasks like integrating GitHub Actions or GitLab CI/CD, configuring lint, test and documentation, as well as implementing settings, logging and other frequently used modules. [Serious Scaffold Python](https://github.com/serious-scaffold/ss-python) streamlines this process. Powered by [copier](https://copier.readthedocs.io/), bootstrapping a new Python project can be done with a single command. By answering a few questions, the project will be fully configured and ready for development. Furthermore, the project can be updated alongside the advancement of the template. +Serious Scaffold Python is crafted for long-term, maintainable Python projects. It includes GitHub Actions and GitLab CI/CD, automated dependency updates via Renovate, and comprehensive linting, testing, and documentation. Key integrations like pdm for environment and dependency management, typer for CLI development, and pydantic for configuration enhance project robustness. With copier’s easy project setup and continuous updating, your project stays aligned with best practices for sustainable development. Pre-configured dev containers and cross-platform CI support ensure maintainability from the start. If you find this helpful, please consider [sponsorship](https://github.com/sponsors/huxuan). diff --git a/includes/copier-answers-sample.yml b/includes/copier-answers-sample.yml index 65d72e39..5defe9c2 100644 --- a/includes/copier-answers-sample.yml +++ b/includes/copier-answers-sample.yml @@ -16,8 +16,7 @@ platforms: - ubuntu - windows project_description: - An evolving Python project template that covers the full development - lifecycle. + A Python Project Template for Long-Term Maintainability. project_name: Serious Scaffold Python repo_name: ss-python repo_namespace: serious-scaffold diff --git a/includes/sample.jinja b/includes/sample.jinja index 4c74f144..3da02c20 100644 --- a/includes/sample.jinja +++ b/includes/sample.jinja @@ -3,7 +3,7 @@ [% from pathjoin("includes", "variable.jinja") import repo_url with context -%] [![{{ project_name }}](https://{{ page_url() }}/_static/images/logo.svg)](https://{{ repo_url() }}) -Setting up a project often involves more than just establishing a basic project structure. It involves tasks like integrating GitHub Actions or GitLab CI/CD, configuring lint, test and documentation, as well as implementing settings, logging and other frequently used modules. [Serious Scaffold Python](https://github.com/serious-scaffold/ss-python) streamlines this process. Powered by [copier](https://copier.readthedocs.io/), bootstrapping a new Python project can be done with a single command. By answering a few questions, the project will be fully configured and ready for development. Furthermore, the project can be updated alongside the advancement of the template. +Serious Scaffold Python is crafted for long-term, maintainable Python projects. It includes GitHub Actions and GitLab CI/CD, automated dependency updates via Renovate, and comprehensive linting, testing, and documentation. Key integrations like pdm for environment and dependency management, typer for CLI development, and pydantic for configuration enhance project robustness. With copier’s easy project setup and continuous updating, your project stays aligned with best practices for sustainable development. Pre-configured dev containers and cross-platform CI support ensure maintainability from the start. [% if repo_platform == 'github' -%] If you find this helpful, please consider [sponsorship](https://github.com/sponsors/{{ author_name }}). diff --git a/pyproject.toml b/pyproject.toml index 91fe892d..60055c10 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ requires = [ [project] name = "ss-python" -description = "An evolving Python project template that covers the full development lifecycle." +description = "A Python Project Template for Long-Term Maintainability." readme = "README.md" keywords = [ "copier-template",