fast-dev-cli 0.7.2__tar.gz → 0.8.0__tar.gz

{fast_dev_cli-0.7.2 → fast_dev_cli-0.8.0}/PKG-INFO

@@ -1,24 +1,34 @@
 Metadata-Version: 2.1
 Name: fast-dev-cli
-Version: 0.7.2
-Summary: 
-Author: Waket Zheng
-Author-email: waketzheng@gmail.com
-Requires-Python: >=3.10,<4.0
-Classifier: Programming Language :: Python :: 3
+Version: 0.8.0
+Summary: Python project development tool.
+Author-Email: Waket Zheng <waketzheng@gmail.com>>
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development
+Classifier: Typing :: Typed
+Classifier: License :: OSI Approved :: MIT License
+Project-URL: Homepage, https://github.com/waketzheng/fast-dev-cli
+Requires-Python: <3.13,>=3.10
+Requires-Dist: typer<0.13,>=0.12.3
+Requires-Dist: typing-extensions>=4.8.0
+Requires-Dist: coverage<8,>=7.5.1
+Requires-Dist: ruff<0.5,>=0.4.4
+Requires-Dist: mypy<2,>=1.10.0
+Requires-Dist: bumpversion<0.7,>=0.6.0
+Requires-Dist: pytest<9,>=8.2.0
+Requires-Dist: ipython<9,>=8.24.0; extra == "all"
+Requires-Dist: pytest-mock<4,>=3.14.0; extra == "all"
 Provides-Extra: all
-Requires-Dist: bumpversion (>=0.6.0,<0.7.0) ; extra == "all"
-Requires-Dist: click (>=7.1.1)
-Requires-Dist: coverage (>=6.5.0) ; extra == "all"
-Requires-Dist: mypy (>=1.10.0,<2.0.0) ; extra == "all"
-Requires-Dist: pytest (>=8.2.0,<9.0.0) ; extra == "all"
-Requires-Dist: ruff (>=0.4.2,<0.5.0) ; extra == "all"
-Requires-Dist: strenum (>=0.4.15) ; python_version < "3.11"
-Requires-Dist: type-extensions (>=0.1.2) ; python_version < "3.11"
-Requires-Dist: typer (>=0.12.3,<0.13.0) ; extra == "all"
 Description-Content-Type: text/markdown
 
 <p align="center">
@@ -54,17 +64,16 @@ Description-Content-Type: text/markdown
 
 ## Requirements
 
-Python 3.11+
+Python 3.10+
 
 ## Installation
 
 <div class="termy">
 
-```console
-$ pip install "fast-dev-cli[all]"
----> 100%
-Successfully installed fast-dev-cli isort black ruff mypy typer bumpversion pytest coverage
+```bash
+pip install "fast-dev-cli"
 ```
+*Will install: fast-dev-cli typer ruff mypy bumpversion pytest coverage*
 
 </div>
 
@@ -94,4 +103,7 @@ fast sync
 ```bash
 fast upgrade
 ```
-
+- Start a fastapi server in development mode
+```bash
+fast dev
+```

{fast_dev_cli-0.7.2 → fast_dev_cli-0.8.0}/README.md

@@ -31,17 +31,16 @@
 
 ## Requirements
 
-Python 3.11+
+Python 3.10+
 
 ## Installation
 
 <div class="termy">
 
-```console
-$ pip install "fast-dev-cli[all]"
----> 100%
-Successfully installed fast-dev-cli isort black ruff mypy typer bumpversion pytest coverage
+```bash
+pip install "fast-dev-cli"
 ```
+*Will install: fast-dev-cli typer ruff mypy bumpversion pytest coverage*
 
 </div>
 
@@ -71,3 +70,7 @@ fast sync
 ```bash
 fast upgrade
 ```
+- Start a fastapi server in development mode
+```bash
+fast dev
+```

{fast_dev_cli-0.7.2 → fast_dev_cli-0.8.0}/fast_dev_cli/cli.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-import importlib.metadata
+import importlib.metadata as importlib_metadata
 import os
 import re
 import subprocess
@@ -8,75 +8,40 @@ import sys
 from functools import cached_property
 from pathlib import Path
 from subprocess import CompletedProcess
-from typing import TYPE_CHECKING, Optional, Type
+from typing import TYPE_CHECKING, Literal, Optional, Type
+
+import typer
+from typer import Exit, Option, echo, secho
 
 if sys.version_info >= (3, 11):
     from enum import StrEnum
     from typing import Self
 else:  # pragma: no cover
-    from strenum import StrEnum  # type:ignore[no-redef,assignment]
+    from enum import Enum
+
     from typing_extensions import Self
 
-if TYPE_CHECKING:
+    class StrEnum(str, Enum):
+        __str__ = str.__str__
+
+
+if TYPE_CHECKING:  # pragma: no cover
     from typer.models import OptionInfo
 
 
-__version__ = importlib.metadata.version(Path(__file__).parent.name)
+__version__ = "0.8.0"
 
 
 def parse_files(args: list[str] | tuple[str, ...]) -> list[str]:
     return [i for i in args if not i.startswith("-")]
 
 
-try:
-    import typer
-    from typer import Exit, Option, echo, secho
-
-    cli = typer.Typer()
-    if len(sys.argv) >= 2 and sys.argv[1] == "lint":
-        if not parse_files(sys.argv[2:]):
-            sys.argv.append(".")
-except ModuleNotFoundError:
-    import click
-    from click import echo, secho
-    from click.core import Group as _Group
-    from click.exceptions import Exit
-
-    def Option(default, *shortcuts, help=None):  # type:ignore[no-redef]
-        return default
-
-    def _command(self, *args, **kwargs):
-        from click.decorators import command
-
-        def decorator(f):
-            if kwargs.get("name") == "lint":
-                import functools
-
-                def auto_fill_args(func):
-                    @functools.wraps(func)
-                    def runner(*arguments: str, **kw):
-                        if "files" not in kw and not parse_files(arguments):
-                            arguments = (".",)
-                        return func(*arguments, **kw)
-
-                    return runner
-
-                f = auto_fill_args(f)
-                if sys.argv[2:]:
-                    f = click.argument("files", nargs=-1)(f)
-            cmd = command(*args, **kwargs)(f)
-            self.add_command(cmd)
-            return cmd
-
-        return decorator
-
-    _Group.command = _command  # type:ignore
-
-    @click.group()
-    def cli() -> None: ...  # pragma: no cover
-
+if len(sys.argv) >= 2 and sys.argv[1] == "lint":
+    if not parse_files(sys.argv[2:]):
+        sys.argv.append(".")
 
 TOML_FILE = "pyproject.toml"
+cli = typer.Typer()
 
 
 def load_bool(name: str, default=False) -> bool:
@@ -98,6 +63,7 @@ def _run_shell(cmd: str, **kw) -> CompletedProcess:
 
 
 def run_and_echo(cmd: str, *, dry=False, verbose=True, **kw) -> int:
+    """Run shell command with subprocess and print it"""
     if verbose:
         echo(f"--> {cmd}")
     if dry:
@@ -117,11 +83,18 @@ def capture_cmd_output(command: list[str] | str, **kw) -> str:
     return r.stdout.strip().decode()
 
 
-def get_current_version(verbose=False) -> str:
+def get_current_version(
+    verbose=False,
+    is_poetry: bool | None = None,
+    package_name=Path(__file__).parent.name,
+) -> str:
+    if is_poetry is None:
+        is_poetry = Project.manage_by_poetry()
+    if not is_poetry:
+        return importlib_metadata.version(package_name)
     cmd = ["poetry", "version", "-s"]
     if verbose:
-        command = " ".join(cmd)
-        echo(f"--> {command}")
+        echo(f"--> {' '.join(cmd)}")
     return capture_cmd_output(cmd)
 
 
@@ -166,13 +139,25 @@ class BumpUp(DryRun):
         major = "major"
 
     def __init__(
-        self: Self, commit: bool, part: str, filename=TOML_FILE, dry=False
+        self: Self, commit: bool, part: str, filename: str | None = None, dry=False
     ) -> None:
         self.commit = commit
         self.part = part
+        if filename is None:
+            filename = self.parse_filename()
         self.filename = filename
         super().__init__(dry=dry)
 
+    @staticmethod
+    def parse_filename() -> str:
+        if not Project.manage_by_poetry():
+            # version = { source = "file", path = "fast_dev_cli/cli.py" }
+            for line in Project.load_toml_text().splitlines():
+                if not line.startswith("version = "):
+                    continue
+                return line.split('path = "', 1)[-1].split('"')[0]
+        return TOML_FILE
+
     def get_part(self, s: str) -> str:
         choices: dict[str, str] = {}
         for i, p in enumerate(self.PartChoices, 1):
@@ -231,7 +216,7 @@ def bump_version(
     dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
 ) -> None:
     """Bump up version string in pyproject.toml"""
-    return BumpUp(_ensure_bool(commit), part.value, dry=dry).run()
+    return BumpUp(_ensure_bool(commit), getattr(part, "value", part), dry=dry).run()
 
 
 def bump() -> None:
@@ -246,7 +231,8 @@ def bump() -> None:
     return BumpUp(commit, part, dry="--dry" in args).run()
 
 
-class EnvError(Exception): ...
+class EnvError(Exception):
+    """Raise when expected to be managed by poetry, but toml file not found."""
 
 
 class Project:
@@ -276,6 +262,23 @@ class Project:
         toml_file = cls.get_work_dir().resolve() / TOML_FILE  # to be optimize
         return toml_file.read_text("utf8")
 
+    @classmethod
+    def manage_by_poetry(cls: Type[Self]) -> bool:
+        return "[tool.poetry]" in cls.load_toml_text()
+
+    @classmethod
+    def get_manage_tool(cls: Type[Self]) -> Literal["poetry", "pdm", ""]:
+        try:
+            text = cls.load_toml_text()
+        except EnvError:
+            pass
+        else:
+            if "[tool.poetry]" in text:
+                return "poetry"
+            elif "[tool.pdm]" in text:
+                return "pdm"
+        return ""
+
     @staticmethod
     def python_exec_dir() -> Path:
         return Path(sys.executable).parent
@@ -396,6 +399,10 @@ class UpgradeDependencies(Project, DryRun):
         if toml_text is None:
             toml_text = cls.load_toml_text()
         main_title = "[tool.poetry.dependencies]"
+        if main_title not in toml_text:
+            raise EnvError(
+                f"{main_title} not found! Make sure this is a poetry project."
+            )
         text = toml_text.split(main_title)[-1]
         dev_flag = "--group dev"
         new_flag, old_flag = cls.DevFlag.new, cls.DevFlag.old
@@ -458,7 +465,8 @@ class GitTag(DryRun):
         self.message = message
         super().__init__(dry=dry)
 
-    def has_v_prefix(self: Self) -> bool:
+    @staticmethod
+    def has_v_prefix() -> bool:
         return "v" in capture_cmd_output("git tag")
 
     def should_push(self: Self) -> bool:
@@ -512,24 +520,28 @@ class LintCode(DryRun):
     @classmethod
     def to_cmd(cls: Type[Self], paths=".", check_only=False) -> str:
         cmd = ""
-        tools = ["ruff check --extend-select=I --fix", "ruff format", "mypy"]
+        tools = ["ruff format", "ruff check --extend-select=I --fix", "mypy"]
         if check_only:
-            tools[1] += " --check"
+            tools[0] += " --check"
         if check_only or load_bool("NO_FIX"):
-            tools[0] = tools[0].replace(" --fix", "")
+            tools[1] = tools[1].replace(" --fix", "")
         if load_bool("SKIP_MYPY"):
             # Sometimes mypy is too slow
             tools = tools[:-1]
         lint_them = " && ".join("{0}{%d} {1}" % i for i in range(2, len(tools) + 2))
-        prefix = "poetry run "
+        prefix = ""
+        should_run_by_tool = False
         if is_venv():
-            if cls.check_lint_tool_installed():
-                prefix = ""
-            else:
+            if not cls.check_lint_tool_installed():
+                should_run_by_tool = True
                 if check_call("python -c 'import fast_dev_cli'"):
-                    command = 'python -m pip install -U "fast_dev_cli[all]"'
-                    tip = "You may need to run the following command to install lint tools"
+                    command = 'python -m pip install -U "fast_dev_cli"'
+                    tip = "You may need to run following command to install lint tools"
                     secho(f"{tip}:\n\n  {command}\n", fg="yellow")
+        else:
+            should_run_by_tool = True
+        if should_run_by_tool:
+            prefix = Project.get_manage_tool() + " run "
         cmd += lint_them.format(prefix, paths, *tools)
         return cmd
 
@@ -614,15 +626,6 @@ def _should_run_test_script(path: Path) -> bool:
     return path.exists()
 
 
-@cli.command(name="test")
-def coverage_test(
-    dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
-    ignore_script: bool = Option(False, "--ignore-script", "-i"),
-) -> None:
-    """Run unittest by pytest and report coverage"""
-    return test(dry, ignore_script)
-
-
 def test(dry: bool, ignore_script=False) -> None:
     cwd = Path.cwd()
     root = Project.get_work_dir(cwd=cwd, allow_cwd=True)
@@ -635,10 +638,20 @@ def test(dry: bool, ignore_script=False) -> None:
         cmd = 'coverage run -m pytest -s && coverage report --omit="tests/*" -m'
         if not is_venv() or not check_call("coverage --version"):
             sep = " && "
-            cmd = sep.join("poetry run " + i for i in cmd.split(sep))
+            tool = Project.get_manage_tool()
+            cmd = sep.join(f"{tool} run " + i for i in cmd.split(sep))
     exit_if_run_failed(cmd, dry=dry)
 
 
+@cli.command(name="test")
+def coverage_test(
+    dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
+    ignore_script: bool = Option(False, "--ignore-script", "-i"),
+) -> None:
+    """Run unittest by pytest and report coverage"""
+    return test(dry, ignore_script)
+
+
 @cli.command()
 def upload(
     dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
@@ -668,9 +681,9 @@ def runserver(
     host: Optional[str] = Option(None, "-h", "--host"),
     dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
 ) -> None:
-    """Check code style without reformat"""
+    """Start a fastapi server(only for fastapi>=0.111.0)"""
     dev(port, host, dry=dry)
 
 
-if __name__ == "__main__":
-    cli()  # pragma: no cover
+if __name__ == "__main__":  # pragma: no cover
+    cli()

fast_dev_cli-0.8.0/pdm_build.py

@@ -0,0 +1,39 @@
+import os
+from typing import Any, Dict, List
+
+from pdm.backend.hooks import Context
+
+BUILD_PACKAGE = os.getenv("BUILD_PACKAGE", "fast-dev-cli")
+
+
+def pdm_build_initialize(context: Context) -> None:
+    metadata = context.config.metadata
+    # Get custom config for the current package, from the env var
+    config: Dict[str, Any] = context.config.data["tool"]["waketzheng"][
+        "_internal-slim-build"
+    ]["packages"][BUILD_PACKAGE]
+    project_config: Dict[str, Any] = config["project"]
+    # Get main optional dependencies, extras
+    optional_dependencies: Dict[str, List[str]] = metadata.get(
+        "optional-dependencies", {}
+    )
+    # Get custom optional dependencies name to always include in this (non-slim) package
+    include_optional_dependencies: List[str] = config.get(
+        "include-optional-dependencies", []
+    )
+    # Override main [project] configs with custom configs for this package
+    for key, value in project_config.items():
+        metadata[key] = value
+    # Get custom build config for the current package
+    build_config: Dict[str, Any] = (
+        config.get("tool", {}).get("pdm", {}).get("build", {})
+    )
+    # Override PDM build config with custom build config for this package
+    for key, value in build_config.items():
+        context.config.build_config[key] = value
+    # Get main dependencies
+    dependencies: List[str] = metadata.get("dependencies", [])
+    # Add optional dependencies to the default dependencies for this (non-slim) package
+    for include_optional in include_optional_dependencies:
+        optional_dependencies_group = optional_dependencies.get(include_optional, [])
+        dependencies.extend(optional_dependencies_group)

fast_dev_cli-0.8.0/pyproject.toml

@@ -0,0 +1,142 @@
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[project]
+name = "fast-dev-cli"
+dynamic = []
+description = "Python project development tool."
+authors = [
+    { name = "Waket Zheng", email = "waketzheng@gmail.com>" },
+]
+readme = "README.md"
+requires-python = ">=3.10,<3.13"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "Typing :: Typed",
+    "License :: OSI Approved :: MIT License",
+]
+dependencies = [
+    "typer>=0.12.3,<0.13",
+    "typing-extensions>=4.8.0",
+    "coverage >=7.5.1,<8",
+    "ruff >=0.4.4,<0.5",
+    "mypy >=1.10.0,<2",
+    "bumpversion >=0.6.0,<0.7",
+    "pytest >=8.2.0,<9",
+]
+version = "0.8.0"
+
+[project.urls]
+Homepage = "https://github.com/waketzheng/fast-dev-cli"
+
+[project.optional-dependencies]
+all = [
+    "ipython >=8.24.0,<9",
+    "pytest-mock >=3.14.0,<4",
+]
+
+[project.scripts]
+fast = "fast_dev_cli:cli.cli"
+
+[tool.pdm]
+distribution = true
+
+[tool.pdm.version]
+source = "file"
+path = "fast_dev_cli/cli.py"
+
+[tool.pdm.build]
+source-includes = [
+    "scripts/",
+]
+
+[tool.pdm.dev-dependencies]
+dev = [
+    "-e file:///${PROJECT_ROOT}/#egg=fast-dev-cli[standard,all]",
+]
+
+[tool.waketzheng._internal-slim-build.packages.fastdevcli-slim.project]
+name = "fastdevcli-slim"
+
+[tool.waketzheng._internal-slim-build.packages.fast-dev-cli]
+include-optional-dependencies = [
+    "standard",
+]
+
+[tool.waketzheng._internal-slim-build.packages.fast-dev-cli.project.optional-dependencies]
+all = [
+    "ipython >=8.24.0,<9",
+    "pytest-mock >=3.14.0,<4",
+]
+
+[tool.waketzheng._internal-slim-build.packages.fast-dev-cli.project.scripts]
+fast = "fast_dev_cli:cli.cli"
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+
+[tool.coverage.run]
+parallel = true
+source = [
+    "fast_dev_cli",
+]
+omit = [
+    "__pypackages__/*",
+    ".venv/*",
+    "venv*.bak/*",
+]
+context = "${CONTEXT}"
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "@overload",
+    "if __name__ == \"__main__\":",
+    "if TYPE_CHECKING:",
+]
+omit = [
+    "tests/*",
+]
+
+[tool.mypy]
+pretty = true
+ignore_missing_imports = true
+check_untyped_defs = true
+exclude = [
+    "^fabfile\\.py$",
+    "two\\.pyi$",
+    "^\\.venv",
+    "\\.bak",
+    "__pypackages__",
+]
+
+[tool.ruff.lint]
+extend-select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "B",
+    "C4",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"test_*.py" = [
+    "E501",
+]

fast_dev_cli-0.8.0/scripts/check.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+[ -f ../pyproject.toml ] && cd ..
+
+pdm run fast check || \
+  echo -e "\033[1m Please run './scripts/format.sh' to auto-fix style issues \033[0m"

fast_dev_cli-0.8.0/scripts/format.sh

@@ -0,0 +1,6 @@
+#!/bin/sh -e
+set -x
+
+[ -f ../pyproject.toml ] && cd ..
+
+pdm run fast lint

fast_dev_cli-0.8.0/scripts/test.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+set -e
+pdm run fast test --ignore-script

fast_dev_cli-0.7.2/pyproject.toml → fast_dev_cli-0.8.0/tests/conftest.py

@@ -1,6 +1,16 @@
+from pathlib import Path
+
+import pytest
+
+from fast_dev_cli.cli import TOML_FILE
+
+from .utils import chdir
+
+# toml file content before migrate to pdm
+TOML_CONTENT = """
 [tool.poetry]
 name = "fast-dev-cli"
-version = "0.7.2"
+version = "0.8.0"
 description = ""
 authors = ["Waket Zheng <waketzheng@gmail.com>"]
 readme = "README.md"
@@ -12,7 +22,7 @@ click = ">=7.1.1"  # Many package depends on click, so only limit min version
 strenum = {version = ">=0.4.15", python = "<3.11"}
 type-extensions = {version = ">=0.1.2", python = "<3.11"}
 coverage = {version = ">=6.5.0", optional = true}
-ruff = {version = "^0.4.2", optional = true}
+ruff = {version = "^0.4.4", optional = true}
 mypy = {version = "^1.10.0", optional = true}
 bumpversion = {version = "^0.6.0", optional = true}
 pytest = {version = "^8.2.0", optional = true}
@@ -25,7 +35,7 @@ all = ["ruff", "typer", "mypy", "bumpversion", "pytest", "coverage"]
 coveralls = {version = ">=4.0.0", python = ">=3.10,<3.13"}
 coverage = ">=6.5.0"  # use >= to compare with coveralls
 typer = "^0.12.3"
-ruff = "^0.4.2"
+ruff = "^0.4.4"
 mypy = "^1.10.0"
 pytest = "^8.2.0"
 ipython = "^8.24.0"
@@ -37,14 +47,11 @@ strenum = "^0.4.15"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+"""
 
-[tool.poetry.scripts]
-fast = "fast_dev_cli:cli.cli"
-
-[tool.mypy]
-pretty = true
-ignore_missing_imports = true
-check_untyped_defs = true
 
-[tool.ruff.lint.per-file-ignores]
-"test_*.py" = ["E501"]
+@pytest.fixture
+def tmp_poetry_project(tmp_path: Path):
+    with chdir(tmp_path):
+        tmp_path.joinpath(TOML_FILE).write_text(TOML_CONTENT)
+        yield