Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<!-- sync:docs/module-tree.txt -->

```text
usethis # usethis: Automate Python project setup and development tasks that are otherwise performed manually.
usethis # usethis: Automatically manage Python tooling and configuration: linters, formatters, and more.
├── __main__ # The CLI application for usethis.
├── _config # Global configuration state for usethis.
├── _config_file # Context managers for coordinated configuration file I/O.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
[![PyPI Supported Versions](https://img.shields.io/pypi/pyversions/usethis.svg)](https://pypi.python.org/pypi/usethis)
[![Docs](https://app.readthedocs.org/projects/usethis/badge/?version=stable)](https://usethis.readthedocs.io/en/stable/)

Automate Python project setup and development tasks that are otherwise performed manually.
Automatically manage Python tooling and configuration: linters, formatters, and more. A CLI for declaratively configuring your Python projects following best practices.

usethis is a command-line interface to automate the configuration of popular Python tools, workflows, and frameworks. You can use it to declaratively add, remove, and configure tools in an existing project, as well as set up a new project from scratch. It won't break your existing configuration, and ensures all tools work together smoothly.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# usethis

Automate Python project setup and development tasks that are otherwise performed manually.
Automatically manage Python tooling and configuration: linters, formatters, and more. A CLI for declaratively configuring your Python projects following best practices.

usethis is a command-line interface to automate the configuration of popular Python tools, workflows, and frameworks. You can use it to declaratively add, remove, and configure tools in an existing project, as well as set up a new project from scratch. It won't break your existing configuration, and ensures all tools work together smoothly.

Expand Down
2 changes: 1 addition & 1 deletion docs/module-tree.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
usethis # usethis: Automate Python project setup and development tasks that are otherwise performed manually.
usethis # usethis: Automatically manage Python tooling and configuration: linters, formatters, and more.
├── __main__ # The CLI application for usethis.
├── _config # Global configuration state for usethis.
├── _config_file # Context managers for coordinated configuration file I/O.
Expand Down
17 changes: 15 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,22 @@ requires = [

[project]
name = "usethis"
description = "Automate Python project setup and development tasks that are otherwise performed manually."
description = "Automatically manage Python tooling and configuration: linters, formatters, and more. A CLI for declaratively configuring your Python projects following best practices."
readme = "README.md"
keywords = [ "init", "project", "setup", "start", "usethis" ]
keywords = [
"config",
"configuration",
"init",
"linting",
"project",
"setup",
"start",
"templating",
"tool",
"tooling",
"tools",
"usethis",
]
license = { file = "LICENSE" }
authors = [
{ name = "Nathan McDougall", email = "nathan.j.mcdougall@gmail.com" },
Expand Down
5 changes: 4 additions & 1 deletion src/usethis/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
"""usethis: Automate Python project setup and development tasks that are otherwise performed manually."""
"""usethis: Automatically manage Python tooling and configuration: linters, formatters, and more.

A CLI for declaratively configuring your Python projects following best practices.
"""
3 changes: 1 addition & 2 deletions src/usethis/_ui/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@

app = typer.Typer(
help=(
"Automate Python package and project setup tasks that are otherwise "
"performed manually."
"Automatically manage Python tooling and configuration: linters, formatters, and more."
),
add_completion=False,
)
Expand Down
4 changes: 2 additions & 2 deletions tests/usethis/_core/test_core_badge.py
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,7 @@ def test_no_unnecessary_spaces(self, bare_dir: Path):

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

Automate Python project setup and development tasks that are otherwise performed manually.
Automatically manage Python tooling and configuration: linters, formatters, and more.
""")

# Act
Expand All @@ -485,7 +485,7 @@ def test_no_unnecessary_spaces(self, bare_dir: Path):
[![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)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit>)](<https://github.com/pre-commit/pre-commit)

Automate Python project setup and development tasks that are otherwise performed manually.
Automatically manage Python tooling and configuration: linters, formatters, and more.
"""
)

Expand Down
Loading