Migrate to Cleo. Add Readme

Author: JrooTJunior

README.md

@@ -1,3 +1,66 @@
 # aiogram-cli
 
-Command line interface
+Command line interface for developers
+
+Works only with [aiogram](https://github.com/aiogram/aiogram) 3.0+ (Is under development)
+
+Here is only bootstrap for CLI interface with extensions based on [pkg_resources](https://setuptools.readthedocs.io/en/latest/pkg_resources.html)
+
+## Installation
+
+### From PyPi
+`pip install --extra-index-url https://dev-docs.aiogram.dev/simple --pre aiogram-cli`
+
+### Poetry
+
+Add this block to `pyproject.toml` file:
+```toml
+[[tool.poetry.source]]
+name = "aiogram-dev"
+url = "https://dev-docs.aiogram.dev/simple"
+secondary = true
+```
+
+And then run: `poetry add -D aiogram-cli`
+
+## Extensions
+
+- `aiogram_cli_generator` (WIP) - Project files generator based on pre-defined cookiecutter templates
+- `aiogram_cli_executor` (WIP) - Executor for bots
+- ...
+
+## Usage
+
+Just run in terminal `aiogram-cli` (Or alias - `aiogram`) and see what you can do with it.
+
+## Example
+
+![main interface](assets/cli.png)
+
+![commands](assets/commands.png)
+
+
+## Writing extensions
+
+Any **aiogram-cli** extension package should provide an entry point like this:
+```
+[aiogram_cli.plugins]
+my_extension = my_package.module:MyCommand
+```
+
+Or with poetry like this:
+```toml
+[tool.poetry.plugins."aiogram_cli.plugins"]
+"builtin-about" = "aiogram_cli.commands.about:AboutCommand"
+"builtin-plugins" = "aiogram_cli.commands.plugins:PluginsListCommand"
+```
+
+This application is based on [cleo](https://cleo.readthedocs.io/en/latest/) framework and that mean all plugins should be one of:
+1. subclass of `cleo.Command`
+1. instance of `cleo.Command`
+1. sequence of subclasses or instances of `cleo.Command`
+1. callable which accepts `app: cleo.Application` and returns any of 1-3 formats
+
+Examples:
+[aiogram_cli.commands.about](aiogram_cli/commands/about.py)
+[aiogram_cli.commands.plugins](aiogram_cli/commands/plugins.py)

aiogram_cli/__main__.py

@@ -0,0 +1,4 @@
+from aiogram_cli.main import main
+
+if __name__ == "__main__":
+    main()

aiogram_cli/commands/about.py

@@ -0,0 +1,18 @@
+from typing import Optional
+
+import aiogram
+from cleo import Command
+
+import aiogram_cli
+
+
+class AboutCommand(Command):
+    name = "about"
+    description = "Get application info"
+    help = description
+
+    def handle(self) -> Optional[int]:
+        self.line(f"aiogram-cli: <comment>v{aiogram_cli.__version__}</comment>")
+        self.line(f"aiogram: <comment>v{aiogram.__version__}</comment>")
+
+        return 0

aiogram_cli/commands/builtin.py

@@ -1,11 +1,32 @@
-import typer
+from typing import Optional
 
-from aiogram_cli.loader import load_plugins_list
+from cleo import Command
+from pkg_resources import EntryPoint
 
+from aiogram_cli.loader import ExtensionsLoader
 
-def plugins() -> None:
-    """
-    Get plugins list
-    """
-    for index, entry_point in enumerate(load_plugins_list(), start=1):
-        typer.echo(f" {index}. {entry_point}")
+
+class PluginsListCommand(Command):
+    name = "plugins"
+    description = "Get installed plugins list"
+    help = description
+    hidden = True
+
+    def handle(self) -> Optional[int]:
+        loader = ExtensionsLoader()
+        for index, entry_point in enumerate(loader.iter_entry_points(), start=1):
+            line = f"{index:>3}. {self.format_entry_point(entry_point)}"
+            self.line(line)
+
+        return 0
+
+    @classmethod
+    def format_entry_point(cls, entry_point: EntryPoint) -> str:
+        line = f"<info>{entry_point.name}</info> from <info>{entry_point.module_name}</info>"
+        if entry_point.attrs:
+            line += " by <info>" + ".".join(entry_point.attrs) + "</info>"
+        if entry_point.extras:
+            line += (
+                " with extras [" + ", ".join(f"<info>{s}</info>" for s in entry_point.extras) + "]"
+            )
+        return line

aiogram_cli/commands/plugins.py

@@ -1,23 +1,44 @@
-from typing import Callable, Generator
+from typing import Any, Callable, Generator, Sequence, Type, Union
 
-import typer
+from cleo import Application, Command
 from pkg_resources import EntryPoint, iter_entry_points
-from typer import Typer
 
+CommandType = Union[Command, Type[Command]]
+CommandLoaderType = Callable[[Application], Union[CommandType, Sequence[CommandType]]]
+CommandExtension = Union[CommandType, CommandLoaderType]
 
-def load_plugins_list() -> Generator[EntryPoint, None, None]:
-    yield from iter_entry_points(group="aiogram_cli.plugins", name=None)
+EXTENSIONS_GROUP = "aiogram_cli.plugins"
 
 
-def resolve_entry_point(app: Typer, entry_point: EntryPoint) -> None:
-    plugin_loader: Callable[[Typer], None] = entry_point.resolve()
-    plugin_loader(app)
+class ExtensionsLoader:
+    def __init__(self, group: str = EXTENSIONS_GROUP) -> None:
+        self.group = group
 
+    def iter_entry_points(self) -> Generator[EntryPoint, None, None]:
+        yield from iter_entry_points(group=self.group, name=None)
 
-def setup_plugins(app: Typer) -> None:
-    for entry_point in load_plugins_list():
-        try:
-            resolve_entry_point(app=app, entry_point=entry_point)
-        except Exception:
-            typer.echo("Failed to load plugin {plugin}", err=True)
-            raise
+    def resolve_entry_points(self) -> Generator[Any, None, None]:
+        for entry_point in self.iter_entry_points():
+            yield entry_point.resolve()
+
+    def _load_plugin(self, plugin: Any, app: Application) -> Generator[Command, None, None]:
+        if isinstance(plugin, Command):
+            yield plugin
+        elif issubclass(plugin, Command):
+            yield plugin()
+        elif isinstance(plugin, Sequence):
+            for item in plugin:
+                yield from self._load_plugin(item, app=app)
+        elif callable(plugin):
+            plugin = plugin(app)
+            yield from self._load_plugin(plugin, app=app)
+        else:
+            raise TypeError(f"{plugin} is not Command or factory")
+
+    def _resolve_plugins(self, app: Application) -> Generator[Command, None, None]:
+        for plugin in self.resolve_entry_points():
+            yield from self._load_plugin(plugin, app=app)
+
+    def setup(self, app: Application) -> None:
+        for command in self._resolve_plugins(app):
+            app.add(command)

aiogram_cli/commands/version.py

@@ -1,11 +1,20 @@
 from typing import Any
 
-import typer
+from cleo import Application
 
-from aiogram_cli.loader import setup_plugins
+from aiogram_cli import __version__
+from aiogram_cli.loader import ExtensionsLoader
+
+
+def get_application() -> Application:
+    app = Application("aiogram-cli", __version__)
+
+    loader = ExtensionsLoader()
+    loader.setup(app=app)
+
+    return app
 
 
 def main() -> Any:
-    app = typer.Typer()
-    setup_plugins(app)
-    return app()
+    app = get_application()
+    return app.run()