Merge pull request #25 from stevenhua0320/fix-cli

fix: fixed command-line-control usability

Author: sbillinge

.pre-commit-config.yaml

@@ -57,10 +57,9 @@ repos:
       - id: prettier
         additional_dependencies:
           - "prettier@^3.2.4"
-  # docformatter - PEP 257 compliant docstring formatter
-  - repo: https://github.com/s-weigand/docformatter
-    rev: 5757c5190d95e5449f102ace83df92e7d3b06c6c
+  # ruff - An extremely fast Python linter and code formatter, written in Rust.
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.12
     hooks:
-      - id: docformatter
-        additional_dependencies: [tomli]
-        args: [--in-place, --config, ./pyproject.toml]
+      - id: ruff-check
+        args: [--fix, --config, ./pyproject.toml]

news/fix-cli.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* <news item>
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* Fixed command line control usability
+
+**Security:**
+
+* <news item>

pyproject.toml

@@ -49,7 +49,7 @@ exclude = []  # exclude packages matching these glob patterns (empty by default)
 namespaces = false  # to disable scanning PEP 420 namespaces (true by default)
 
 [project.scripts]
-diffpy-distanceprinter = "diffpy.distanceprinter.distanceprinter_app:main"
+distanceprinter = "diffpy.distanceprinter.distanceprinter:main"
 
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements/pip.txt"]}
@@ -59,10 +59,11 @@ exclude-file = ".codespell/ignore_lines.txt"
 ignore-words = ".codespell/ignore_words.txt"
 skip = "*.cif,*.dat"
 
-[tool.docformatter]
-recursive = true
-wrap-summaries = 72
-wrap-descriptions = 72
+[tool.ruff]
+line-length = 72
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
 
 [tool.black]
 line-length = 79