beanqueue 1.0.0__tar.gz → 1.1.1__tar.gz

{beanqueue-1.0.0 → beanqueue-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: beanqueue
-Version: 1.0.0
+Version: 1.1.1
 Summary: BeanQueue or BQ for short, PostgreSQL SKIP LOCK and SQLAlchemy based worker queue library
 License: MIT
 Author: Fang-Pen Lin
@@ -14,6 +14,7 @@ Requires-Dist: blinker (>=1.8.2,<2.0.0)
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: pg-activity (>=3.5.1,<4.0.0)
 Requires-Dist: pydantic-settings (>=2.2.1,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
 Requires-Dist: sqlalchemy (>=2.0.30,<3.0.0)
 Requires-Dist: venusian (>=3.1.0,<4.0.0)
 Description-Content-Type: text/markdown
@@ -113,20 +114,20 @@ db.commit()
 To run the worker, you can do this:
 
 ```bash
-BQ_PROCESSOR_PACKAGES='["my_pkgs.processors"]' python -m bq.cmds.process images
+BQ_PROCESSOR_PACKAGES='["my_pkgs.processors"]' bq process images
 ```
 
 The `BQ_PROCESSOR_PACKAGES` is a JSON list contains the Python packages where you define your processors (the functions you decorated with `bq.processors.registry.processor`).
 To submit a task for testing purpose, you can do
 
 ```bash
-python -m bq.cmds.submit images my_pkgs.processors resize_image -k '{"width": 200, "height": 300}'
+bq submit images my_pkgs.processors resize_image -k '{"width": 200, "height": 300}'
 ```
 
 To create tables for BeanQueue, you can run
 
 ```bash
-python -m bq.cmds.create_tables
+bq create_tables
 ```
 
 ### Schedule
@@ -228,7 +229,7 @@ app = bq.BeanQueue(config=config)
 Then you can pass `--app` argument (or `-a` for short) pointing to the app object to the process command like this:
 
 ```bash
-python -m bq.cmds.process -a my_pkgs.bq.app images
+bq -a my_pkgs.bq.app process images
 ```
 
 Or if you prefer to define your own process command, you can also call `process_tasks` of the `BeanQueue` object directly like this:

{beanqueue-1.0.0 → beanqueue-1.1.1}/README.md

@@ -93,20 +93,20 @@ db.commit()
 To run the worker, you can do this:
 
 ```bash
-BQ_PROCESSOR_PACKAGES='["my_pkgs.processors"]' python -m bq.cmds.process images
+BQ_PROCESSOR_PACKAGES='["my_pkgs.processors"]' bq process images
 ```
 
 The `BQ_PROCESSOR_PACKAGES` is a JSON list contains the Python packages where you define your processors (the functions you decorated with `bq.processors.registry.processor`).
 To submit a task for testing purpose, you can do
 
 ```bash
-python -m bq.cmds.submit images my_pkgs.processors resize_image -k '{"width": 200, "height": 300}'
+bq submit images my_pkgs.processors resize_image -k '{"width": 200, "height": 300}'
 ```
 
 To create tables for BeanQueue, you can run
 
 ```bash
-python -m bq.cmds.create_tables
+bq create_tables
 ```
 
 ### Schedule
@@ -208,7 +208,7 @@ app = bq.BeanQueue(config=config)
 Then you can pass `--app` argument (or `-a` for short) pointing to the app object to the process command like this:
 
 ```bash
-python -m bq.cmds.process -a my_pkgs.bq.app images
+bq -a my_pkgs.bq.app process images
 ```
 
 Or if you prefer to define your own process command, you can also call `process_tasks` of the `BeanQueue` object directly like this:

beanqueue-1.1.1/bq/cmds/cli.py

@@ -0,0 +1,44 @@
+import logging
+import os
+
+import click
+from rich.logging import RichHandler
+
+from .environment import Environment
+from .environment import LOG_LEVEL_MAP
+from .environment import LogLevel
+from .environment import pass_env
+from .utils import load_app
+
+
+@click.group(help="Command line tools for BeanQueue")
+@click.option(
+    "-l",
+    "--log-level",
+    type=click.Choice(
+        list(map(lambda key: key.value, LOG_LEVEL_MAP.keys())), case_sensitive=False
+    ),
+    default=lambda: os.environ.get("LOG_LEVEL", "INFO"),
+)
+@click.option(
+    "--disable-rich-log",
+    is_flag=True,
+    help="disable rich log handler",
+)
+@click.option(
+    "-a", "--app", type=str, help='BeanQueue app object to use, e.g. "my_pkgs.bq.app"'
+)
+@click.version_option(prog_name="bq", package_name="bq")
+@pass_env
+def cli(env: Environment, log_level: str, disable_rich_log: bool, app: str):
+    env.log_level = LogLevel(log_level)
+    env.app = load_app(app)
+
+    FORMAT = "%(message)s"
+    logging.basicConfig(
+        level=LOG_LEVEL_MAP[env.log_level],
+        format=FORMAT,
+        datefmt="[%X]",
+        force=True,
+        **(dict(handlers=[RichHandler()]) if not disable_rich_log else {})
+    )

beanqueue-1.1.1/bq/cmds/create_tables.py

@@ -0,0 +1,12 @@
+from .. import models  # noqa
+from ..db.base import Base
+from .cli import cli
+from .environment import Environment
+from .environment import pass_env
+
+
+@cli.command(name="create_tables", help="Create BeanQueue tables")
+@pass_env
+def create_tables(env: Environment):
+    Base.metadata.create_all(bind=env.app.engine)
+    env.logger.info("Done, tables created")

beanqueue-1.1.1/bq/cmds/environment.py

@@ -0,0 +1,36 @@
+import dataclasses
+import enum
+import logging
+
+import click
+
+from ..app import BeanQueue
+
+
+@enum.unique
+class LogLevel(enum.Enum):
+    VERBOSE = "verbose"
+    DEBUG = "debug"
+    INFO = "info"
+    WARNING = "warning"
+    ERROR = "error"
+    FATAL = "fatal"
+
+
+LOG_LEVEL_MAP = {
+    LogLevel.DEBUG: logging.DEBUG,
+    LogLevel.INFO: logging.INFO,
+    LogLevel.WARNING: logging.WARNING,
+    LogLevel.ERROR: logging.ERROR,
+    LogLevel.FATAL: logging.FATAL,
+}
+
+
+@dataclasses.dataclass
+class Environment:
+    log_level: LogLevel = LogLevel.INFO
+    logger: logging.Logger = logging.getLogger("bq")
+    app: BeanQueue = BeanQueue()
+
+
+pass_env = click.make_pass_decorator(Environment, ensure=True)

beanqueue-1.1.1/bq/cmds/main.py

@@ -0,0 +1,9 @@
+from . import create_tables  # noqa
+from . import process  # noqa
+from . import submit  # noqa
+from .cli import cli
+
+__ALL__ = [cli]
+
+if __name__ == "__main__":
+    cli()

beanqueue-1.1.1/bq/cmds/process.py

@@ -0,0 +1,15 @@
+import click
+
+from .cli import cli
+from .environment import Environment
+from .environment import pass_env
+
+
+@cli.command(name="process", help="Process BeanQueue tasks")
+@click.argument("channels", nargs=-1)
+@pass_env
+def process(
+    env: Environment,
+    channels: tuple[str, ...],
+):
+    env.app.process_tasks(channels)

{beanqueue-1.0.0 → beanqueue-1.1.1}/bq/cmds/submit.py

@@ -1,48 +1,42 @@
 import json
-import logging
 
 import click
 
 from .. import models
-from .utils import load_app
+from .cli import cli
+from .environment import Environment
+from .environment import pass_env
 
-logger = logging.getLogger(__name__)
 
-
-@click.command()
+@cli.command(name="submit", help="Submit a new task, mostly for debugging purpose")
 @click.argument("channel", nargs=1)
 @click.argument("module", nargs=1)
 @click.argument("func", nargs=1)
 @click.option(
     "-k", "--kwargs", type=str, help="Keyword arguments as JSON", default=None
 )
-@click.option(
-    "-a", "--app", type=str, help='BeanQueue app object to use, e.g. "my_pkgs.bq.app"'
-)
-def main(
+@pass_env
+def submit(
+    env: Environment,
     channel: str,
     module: str,
     func: str,
     kwargs: str | None,
-    app: str | None = None,
 ):
-    app = load_app(app)
-    db = app.session_cls(bind=app.create_default_engine())
+    db = env.app.session_cls(bind=env.app.create_default_engine())
 
-    logger.info(
+    env.logger.info(
         "Submit task with channel=%s, module=%s, func=%s", channel, module, func
     )
     kwargs_value = {}
     if kwargs:
         kwargs_value = json.loads(kwargs)
     task = models.Task(
-        channel=channel, module=module, func_name=func, kwargs=kwargs_value
+        channel=channel,
+        module=module,
+        func_name=func,
+        kwargs=kwargs_value,
     )
     db.add(task)
     db.commit()
-    logger.info("Done, submit task %s", task.id)
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    main()
+    env.logger.info("Done, submit task %s", task.id)

{beanqueue-1.0.0 → beanqueue-1.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "beanqueue"
-version = "1.0.0"
+version = "1.1.1"
 description = "BeanQueue or BQ for short, PostgreSQL SKIP LOCK and SQLAlchemy based worker queue library"
 authors = ["Fang-Pen Lin <fangpen@launchplatform.com>"]
 license = "MIT"
@@ -9,6 +9,9 @@ packages = [
     { include = "bq" },
 ]
 
+[tool.poetry.scripts]
+bq = "bq.cmds.main:cli"
+
 [tool.poetry.dependencies]
 python = "^3.11"
 sqlalchemy = "^2.0.30"
@@ -17,6 +20,7 @@ click = "^8.1.7"
 pydantic-settings = "^2.2.1"
 pg-activity = "^3.5.1"
 blinker = "^1.8.2"
+rich = "^13.7.1"
 
 
 [tool.poetry.group.dev.dependencies]

beanqueue-1.0.0/bq/cmds/create_tables.py

@@ -1,26 +0,0 @@
-import logging
-
-import click
-
-from .. import models  # noqa
-from ..db.base import Base
-from .utils import load_app
-
-logger = logging.getLogger(__name__)
-
-
-@click.command()
-@click.option(
-    "-a", "--app", type=str, help='BeanQueue app object to use, e.g. "my_pkgs.bq.app"'
-)
-def main(
-    app: str | None = None,
-):
-    app = load_app(app)
-    Base.metadata.create_all(bind=app.engine)
-    logger.info("Done, tables created")
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    main()

beanqueue-1.0.0/bq/cmds/process.py

@@ -1,23 +0,0 @@
-import logging
-
-import click
-
-from .utils import load_app
-
-
-@click.command()
-@click.argument("channels", nargs=-1)
-@click.option(
-    "-a", "--app", type=str, help='BeanQueue app object to use, e.g. "my_pkgs.bq.app"'
-)
-def main(
-    channels: tuple[str, ...],
-    app: str | None = None,
-):
-    app = load_app(app)
-    app.process_tasks(channels)
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    main()