cihai-cli 0.24.0__tar.gz → 0.25.0__tar.gz

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cihai-cli
-Version: 0.24.0
+Version: 0.25.0
 Summary: Command line frontend for the cihai CJK language library
 Home-page: https://cihai-cli.git-pull.com
 License: MIT
@@ -25,7 +25,7 @@ Classifier: Topic :: Software Development :: Localization
 Classifier: Topic :: System :: Shells
 Classifier: Topic :: Utilities
 Requires-Dist: PyYAML
-Requires-Dist: cihai (>=0.29.0,<0.30.0)
+Requires-Dist: cihai (>=0.30.0,<0.31.0)
 Project-URL: Bug Tracker, https://github.com/cihai/cihai-cli/issues
 Project-URL: Documentation, https://cihai-cli.git-pull.com
 Project-URL: Q & A, https://github.com/cihai/cihai-cli/discussions

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cihai-cli"
-version = "0.24.0"
+version = "0.25.0"
 description = "Command line frontend for the cihai CJK language library"
 license = "MIT"
 authors = ["Tony Narlock <tony@git-pull.com>"]
@@ -58,14 +58,14 @@ Repository = "https://github.com/cihai/cihai-cli"
 
 [tool.poetry.dependencies]
 python = "^3.8"
-cihai = "~0.29.0"
+cihai = "~0.30.0"
 PyYAML = "*"
 
 [tool.poetry.group.docs.dependencies]
 ### Docs ###
 sphinx = "*"
-gp-libs = "*"
 furo = "*"
+gp-libs = "*"
 sphinx-autobuild = "*"
 sphinx-autodoc-typehints = "*"
 sphinx-argparse = "*"
@@ -81,6 +81,7 @@ docutils = "*"
 pytest = "*"
 pytest-rerunfailures = "*"
 pytest-watcher = "*"
+gp-libs = "*"
 
 [tool.poetry.group.coverage.dependencies]
 ### Coverage ###
@@ -128,12 +129,16 @@ select = [
   "TRY", # Trycertatops
   "PERF", # Perflint
   "RUF", # Ruff-specific rules
+  "D", # pydocstyle
 ]
 
 [tool.ruff.isort]
 known-first-party = ["unihan_etl", "cihai"]
 combine-as-imports = true
 
+[tool.ruff.pydocstyle]
+convention = "numpy"
+
 [tool.ruff.per-file-ignores]
 "*/__init__.py" = ["F401"]
 

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/src/cihai_cli/__about__.py

@@ -1,6 +1,7 @@
+"""Metadata for cihai_cli package."""
 __title__ = "cihai-cli"
 __package_name__ = "cihai_cli"
-__version__ = "0.24.0"
+__version__ = "0.25.0"
 __description__ = "Command line frontend for the cihai CJK language library"
 __author__ = "Tony Narlock"
 __email__ = "tony@git-pull.com"

cihai_cli-0.25.0/src/cihai_cli/__init__.py

@@ -0,0 +1 @@
+"""Package for Cihai's CLI frontend."""

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/src/cihai_cli/cli.py

@@ -1,3 +1,4 @@
+"""CLI functionality for cihai-cli."""
 import argparse
 import logging
 import sys
@@ -30,6 +31,7 @@ INFO_SHORT_HELP = 'Get details on a CJK character, e.g. "好"'
 
 
 def create_parser() -> argparse.ArgumentParser:
+    """Create argparse for cihai-cli."""
     parser = argparse.ArgumentParser(prog="cihai")
     parser.add_argument(
         "--version",
@@ -65,6 +67,8 @@ def create_parser() -> argparse.ArgumentParser:
 
 
 class CLILoadNamespace(argparse.Namespace):
+    """Typing for CLI namespace."""
+
     config_file: t.Optional[str]
     version: bool
     log_file: t.Optional[str]
@@ -75,8 +79,8 @@ def cli(_args: t.Optional[t.List[str]] = None) -> None:
 
     For help and example usage, see documentation:
 
-    https://cihai-cli.git-pull.com and https://cihai.git-pull.com"""
-
+    https://cihai-cli.git-pull.com and https://cihai.git-pull.com
+    """
     parser = create_parser()
     args = parser.parse_args(_args, namespace=CLILoadNamespace())
 
@@ -100,6 +104,7 @@ def cli(_args: t.Optional[t.List[str]] = None) -> None:
 
 
 def create_info_subparser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
+    """Create ``cihai info`` subparser."""
     parser.add_argument("char", metavar="<character>", help="Lookup term / character")
     parser.add_argument(
         "--all",
@@ -132,6 +137,7 @@ def command_info(c: Cihai, char: str, show_all: bool) -> None:
 def create_reverse_subparser(
     parser: argparse.ArgumentParser,
 ) -> argparse.ArgumentParser:
+    """Create ``cihai reverse`` subparser."""
     parser.add_argument("char", metavar="<character>", help="Lookup term / character")
     parser.add_argument(
         "--all",
@@ -168,7 +174,7 @@ def command_reverse(c: Cihai, char: str, show_all: bool) -> None:
 def setup_logger(
     logger: t.Optional[logging.Logger] = None, level: str = "INFO"
 ) -> None:
-    """Setup logging for CLI use.
+    """Configure logging for CLI use.
 
     :param logger: instance of logger
     :type logger: :py:class:`Logger`

cihai_cli-0.25.0/tests/__init__.py

@@ -0,0 +1 @@
+"""Test package for cihai-cli."""

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/tests/conftest.py

@@ -1,3 +1,4 @@
+"""Pytest configuration."""
 import pathlib
 import typing as t
 import zipfile
@@ -12,26 +13,31 @@ if t.TYPE_CHECKING:
 
 @pytest.fixture
 def tests_path() -> pathlib.Path:
+    """Return tests/ directory."""
     return pathlib.Path(__file__).parent
 
 
 @pytest.fixture
 def fixture_path(tests_path: pathlib.Path) -> pathlib.Path:
+    """Return tests/fixtures/ directory."""
     return tests_path / "fixtures"
 
 
 @pytest.fixture
 def test_config_file(fixture_path: pathlib.Path) -> pathlib.Path:
+    """Return test_config.yml file."""
     return fixture_path / "test_config.yml"
 
 
 @pytest.fixture
 def zip_path(tmp_path: pathlib.Path) -> pathlib.Path:
+    """Return Unihan.zip in temporary path."""
     return tmp_path / "Unihan.zip"
 
 
 @pytest.fixture
 def zip_file(zip_path: pathlib.Path, fixture_path: pathlib.Path) -> zipfile.ZipFile:
+    """Create and return ZipFile."""
     _files = []
     for f in UNIHAN_FILES:
         _files += [fixture_path / f]
@@ -46,6 +52,7 @@ def zip_file(zip_path: pathlib.Path, fixture_path: pathlib.Path) -> zipfile.ZipF
 def unihan_options(
     zip_file: zipfile.ZipFile, zip_path: pathlib.Path, tmp_path: pathlib.Path
 ) -> "UnihanOptions":
+    """Return UnihanOptions for fixture."""
     return {
         "source": zip_path,
         "work_dir": tmp_path,
@@ -55,4 +62,5 @@ def unihan_options(
 
 @pytest.fixture(scope="function")
 def tmpdb_file(tmpdir: pathlib.Path) -> pathlib.Path:
+    """Return test SQLite database."""
     return tmpdir / "test.db"

{cihai_cli-0.24.0 → cihai_cli-0.25.0}/tests/test_cli.py

@@ -1,3 +1,4 @@
+"""CLI tests for cihai-cli."""
 import contextlib
 import pathlib
 import typing as t
@@ -16,6 +17,7 @@ def test_cli(
     capsys: pytest.CaptureFixture[str],
     monkeypatch: pytest.MonkeyPatch,
 ) -> None:
+    """Test basic cihai usage."""
     monkeypatch.chdir(tmp_path)
 
     with contextlib.suppress(SystemExit):
@@ -38,6 +40,7 @@ def test_cli_reflects_after_bootstrap(
     tmpdb_file: pathlib.Path,
     unihan_options: "UnihanOptions",
 ) -> None:
+    """High-level, integrative CLI-based test."""
     config = {
         "database": {"url": f"sqlite:///{tmpdb_file}s"},
         "unihan_options": {
@@ -73,6 +76,7 @@ def test_cli_version(
     monkeypatch: pytest.MonkeyPatch,
     flag: str,
 ) -> None:
+    """Returns cihai-cli version."""
     try:
         cli([flag])
     except SystemExit: