afwf_example 0.1.1__py3-none-any.whl

afwf_example/__init__.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

afwf_example/cache.py

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+"""
+Disk cache for Alfred Workflow.
+"""
+
+from diskcache import Cache
+
+from .paths import dir_cache
+
+cache = Cache(dir_cache.abspath)

afwf_example/cli.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+import json
+
+
+class Command:
+    def open_url_new(self, query: str = ""):
+        from afwf_example.handlers.open_url_new import handler
+
+        sf = handler.handler(query)
+        print(json.dumps(sf.to_script_filter(), indent=4))
+
+
+def main():
+    import fire
+
+    fire.Fire(Command)
+
+
+if __name__ == "__main__":
+    main()

afwf_example/handlers/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+

afwf_example/handlers/error.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+"""
+This handler will always raise an error. It is used for testing purpose.
+"""
+
+import typing as T
+import attrs
+import afwf.api as afwf
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self) -> afwf.ScriptFilter:
+        afwf.log_debug_info("before raising the error")
+        raise Exception("raise this error intentionally")
+
+    def parse_query(self, query: str) -> T.Dict[str, T.Any]:
+        return {}
+
+
+handler = Handler(id="error")

afwf_example/handlers/memorize_cache.py

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是根据 key 随机生成一个 1 ~ 1000 之间的 value. 这个 value 的值
+将会被缓存 5 秒. 5 秒内查询同一个 key 的结果将会是一样的. 该例子用来展示如何使用 time to live
+缓存.
+
+在 Alfred Workflow 的 Canvas 界面中 Script Filter 的设置如下:
+
+- Keyword: afwf-example-memorize-cache, Argument Required
+- Language: /bin/bash
+- Script: python main.py 'memorize_cache {query}'
+"""
+
+import random
+
+import attrs
+import afwf.api as afwf
+
+from ..cache import cache
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    @cache.memoize(tag="memorize_cache", expire=5)
+    def main(self, key: str) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        value = random.randint(1, 1000)
+        item = afwf.Item(
+            title=f"value is {value}",
+        )
+        sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return dict(
+            key=query,
+        )
+
+
+handler = Handler(id="memorize_cache")

afwf_example/handlers/open_file.py

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是展示当前这个 handlers 文件夹下的所有 Python 文件供用户选择,
+用户可以用上下选择文件, 也可以输入字符来过滤文件. 选中后按回车就会用默认应用打开对应的文件.
+
+我们准备用 Alfred filters results 功能帮我们过滤文件, 所以我们无需在 main() 中接收参数,
+ 免去了自己实现过滤文件的功能. 那么我们在实现 ``parse_query()`` 函数的时候直接返回空字典即可.
+
+在 Alfred Workflow 的 Canvas 界面中 Script Filter 的设置如下:
+
+- Keyword: afwf-example-open-file, Argument Optional
+- Language: /bin/bash
+- Script: python main.py 'open_file {query}'
+- Alfred filters results: checked
+- 连接一个 Utilities - Conditional 的控件, 条件是 ``{var:open_file}`` is equal to ``y``.
+- 连接一个 Actions - Open File 的控件, File 的参数是 ``{var:open_file_path}``.
+"""
+
+import attrs
+from pathlib_mate import Path
+import afwf.api as afwf
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        dir_here = Path.dir_here(__file__)
+        for p in dir_here.iterdir():
+            if p.ext.lower() == ".py":
+                item = afwf.Item(
+                    title=p.basename,
+                    subtitle=f"Open {p.abspath}",
+                    autocomplete=p.basename,
+                    match=p.basename,
+                    arg=p.abspath,
+                )
+                item.open_file(path=p.abspath)
+                sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return {}
+
+
+handler = Handler(id="open_file")

afwf_example/handlers/open_url.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是展示一些预先定义好的网站的名字和 URL. 然后选中后按回车就会在浏览器
+内打开对应网站.
+
+这个 Script Filter 没有输入参数. 所以 ``main()`` 函数也没有参数. 那么我们在实现
+``parse_query()`` 函数的时候直接返回空字典即可.
+
+在 Alfred Workflow 的 Canvas 界面中 Script Filter 的设置如下:
+
+- Keyword: afwf-example-open-url, No Argument
+- Language: /bin/bash
+- Script: python main.py 'open_url {query}', 这里我们没有勾选 Alfred filters results. 因为我们不需要 Alfred 帮我们过滤结果.
+- 连接一个 Utilities - Conditional 的控件, 条件是 ``{var:open_url}`` is equal to ``y``.
+- 连接一个 Actions - Open Url 的控件, URL 的参数是 ``{var:open_url_arg}``.
+"""
+
+import attrs
+import afwf.api as afwf
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        for title, url in [
+            ("Alfred App", "https://www.alfredapp.com/"),
+            ("Python", "https://www.python.org/"),
+            ("GitHub", "https://github.com/"),
+        ]:
+            item = afwf.Item(
+                title=title,
+                subtitle=f"open {url}",
+                autocomplete=title,
+                arg=url,
+            )
+            item.open_url(url=url)
+            sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return {}
+
+
+handler = Handler(id="open_url")

afwf_example/handlers/open_url_new.py

@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是展示一些预先定义好的网站的名字和 URL. 然后选中后按回车就会在浏览器
+内打开对应网站.
+
+这个 Script Filter 没有输入参数. 所以 ``main()`` 函数也没有参数. 那么我们在实现
+``parse_query()`` 函数的时候直接返回空字典即可, ``encode_query()`` 也直接返回空字符串.
+
+在 Alfred Workflow 的 Canvas 界面中 Script Filter 的设置如下:
+
+- Keyword: afwf-example-open-url, No Argument
+- Language: /bin/bash
+- Script: python main.py 'open_url {query}', 这里我们没有勾选 Alfred filters results. 因为我们不需要 Alfred 帮我们过滤结果.
+- 连接一个 Utilities - Conditional 的控件, 条件是 ``{var:open_url}`` is equal to ``y``.
+- 连接一个 Actions - Open Url 的控件, URL 的参数是 ``{var:open_url_arg}``.
+"""
+
+from afwf.handler import Handler
+from afwf.script_filter import ScriptFilter
+from afwf.item import Item
+
+
+class OpenUrlHandler(Handler):
+    def parse_query(self, query: str) -> dict:
+        return {}
+
+    def encode_query(self, **kwargs) -> str:
+        return ""
+
+    def main(self) -> ScriptFilter:
+        sf = ScriptFilter()
+        for title, url in [
+            ("Alfred App", "https://www.alfredapp.com/"),
+            ("Python", "https://www.python.org/"),
+            ("GitHub", "https://github.com/"),
+        ]:
+            item = Item(
+                title=title,
+                subtitle=f"open {url}",
+                autocomplete=title,
+                arg=url,
+            )
+            item.open_url(url=url)
+            sf.items.append(item)
+        return sf
+
+
+handler = OpenUrlHandler(id="open_url")

afwf_example/handlers/read_file.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是展示 file.txt 文件中的内容. 仅仅是和 ``write_file.py`` 模块
+配合使用, 永远验证.
+"""
+
+import attrs
+import afwf.api as afwf
+
+from ..paths import dir_project_home
+
+path_file = dir_project_home / "file.txt"
+path_file.parent.mkdir(parents=True, exist_ok=True)
+if path_file.exists() is False:
+    path_file.write_text("hello world")
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        if path_file.exists():
+            content = path_file.read_text()
+            item = afwf.Item(
+                title=f"content of {path_file} is",
+                subtitle=content,
+            )
+        else:
+            item = afwf.Item(
+                title=f"{path_file} does not exist!",
+            )
+            item.set_icon(afwf.IconFileEnum.error)
+
+        sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return {}
+
+
+handler = Handler(id="read_file")

afwf_example/handlers/set_settings.py

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是让用户对用作 settings 的 sqlite 写入. 可以和 ``view_settings.py``
+模块配合使用查看效果.
+"""
+
+import typing as T
+import sys
+
+import attrs
+import afwf.api as afwf
+
+from ..settings import settings, SettingsKeyEnum
+
+
+@attrs.define
+class SetSettingValueHandler(afwf.Handler):
+    def main(self, key: str, value: str) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        settings[key] = value
+        return sf
+
+    def parse_query(self, query: str):
+        key, value = query.split(" ", 1)
+        return dict(
+            key=key,
+            value=value,
+        )
+
+    def encode_query(self, key: str, value: str) -> str:
+        return f"{key} {value}"
+
+
+set_setting_value_handler = SetSettingValueHandler(id="set_setting_value")
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(
+        self,
+        key: T.Optional[str] = None,
+        value: T.Optional[str] = None,
+    ) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+
+        if key is None:
+            for settings_key in SettingsKeyEnum:
+                item = afwf.FuzzyItem(
+                    title=settings_key.value,
+                    subtitle=f"set {settings_key.value} to ...",
+                    autocomplete=settings_key.value + " ",
+                ).set_fuzzy_match_name(settings_key.value)
+                sf.items.append(item)
+        elif value is None:
+            items = list()
+            for settings_key in SettingsKeyEnum:
+                item = afwf.FuzzyItem(
+                    title=settings_key.value,
+                    subtitle=f"set {settings_key.value} to ...",
+                    autocomplete=settings_key.value + " ",
+                ).set_fuzzy_match_name(settings_key.value)
+                items.append(item)
+            matcher = afwf.FuzzyItemMatcher.from_items(items)
+            sf.items.extend(matcher.match(key, threshold=0))
+        else:
+            if key in SettingsKeyEnum.__members__:
+                item = afwf.Item(
+                    title=f"Set settings.{key} = {value!r}",
+                )
+                item.send_notification(
+                    title=f"Set settings.{key} = {value!r}",
+                )
+                cmd = set_setting_value_handler.encode_run_script_command(
+                    bin_python=sys.executable,
+                    key=key,
+                    value=value,
+                )
+                item.run_script(cmd)
+                sf.items.append(item)
+            else:
+                item = afwf.Item(
+                    title=f"{key!r} is not a valid settings key",
+                )
+                item.set_icon(afwf.IconFileEnum.error)
+                sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        q = afwf.Query.from_str(query)
+        if q.n_trimmed_parts == 0:
+            return dict(key=None, value=None)
+        elif q.n_trimmed_parts == 1:
+            return dict(key=q.trimmed_parts[0], value=None)
+        elif q.n_trimmed_parts == 2:
+            return dict(key=q.trimmed_parts[0], value=q.trimmed_parts[1])
+        else:
+            raise NotImplementedError
+
+
+handler = Handler(id="set_settings")

afwf_example/handlers/view_settings.py

@@ -0,0 +1,33 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是让用户对用作 settings 的 sqlite 进行读取. 可以和 ``set_settings.py``
+模块配合使用查看效果.
+"""
+
+import attrs
+import afwf.api as afwf
+
+from ..settings import path_settings_sqlite, settings, SettingsKeyEnum
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        for settings_key in SettingsKeyEnum:
+            value = settings.get(settings_key.value)
+            item = afwf.Item(
+                title=f"settings.{settings_key} = {value!r}",
+                subtitle=f"settings are stored at {path_settings_sqlite}",
+            )
+            sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return {}
+
+
+handler = Handler(id="view_settings")

afwf_example/handlers/write_file.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+
+"""
+[CN]
+
+该 Script Filter 的功能是让用户将文本写入特定文件. 该例子用来展示如何实现按下回车后执行任意
+Python 逻辑. 该技巧可以用来实现按下回车后做到任何事情, 因为底层就是一个 Python 脚本.
+
+其原理如下:
+
+我们这里多了一个 ``WriteRequestHandler`` 的 handler. 这个 handler 并不会跟任何
+Script Filter 所对应, 而是仅仅作为一个 CLI 命令行接口而存在. 这样我们在其他的 handler 中
+只要将 item 之后的 action 定义为 Run Script, 那么就可以按下回车后用 bash 来执行任何
+Python 逻辑. 而这个 bash command 就是 item 的 argument. 这个 ``WriteRequestHandler``
+则是实现了 bash command 所对应的功能.
+
+``WriteRequestHandler`` 实现了将任意 content 写入 file.txt 的功能. 并且在
+``encode_query()`` 中实现了如何将 main 中的参数编码成字符串的函数.
+
+``Handler`` 则实现了 Script Filter 的功能.
+
+在 Alfred Workflow 的 Canvas 界面中 Script Filter 的设置如下:
+
+- Keyword: afwf-example-write-file, Argument Required
+- Language: /bin/bash
+- Script: python main.py 'write_file {query}'
+- 连接一个 Utilities - Conditional 的控件, 条件是 ``{var:run_script}`` is equal to ``y``.
+- 连接一个 Actions - Run Script 的控件, Script 的参数是 ``{query}``.
+- 连接一个 Utilities - Conditional 的控件, 条件是 ``{var:send_notification}`` is equal to ``y``.
+- 连接一个 Outputs - Post Notification 的控件, Title 的参数是 ``{var:send_notification_title}``
+    Subtitle 的参数是 ``{var:send_notification_subtitle}``.
+"""
+
+import sys
+
+import attrs
+import afwf.api as afwf
+
+from ..paths import dir_project_home
+
+
+@attrs.define
+class WriteRequestHandler(afwf.Handler):
+    def main(self, content: str) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        path = dir_project_home / "file.txt"
+        path.write_text(content)
+        return sf
+
+    def parse_query(self, query: str):
+        return dict(
+            content=query,
+        )
+
+    def encode_query(self, content: str) -> str:
+        return content
+
+
+write_request_handler = WriteRequestHandler(id="write_request_handler")
+
+
+path_file = dir_project_home / "file.txt"
+path_file.parent.mkdir(parents=True, exist_ok=True)
+
+
+@attrs.define
+class Handler(afwf.Handler):
+    def main(self, content: str) -> afwf.ScriptFilter:
+        sf = afwf.ScriptFilter()
+        item = afwf.Item(
+            title=f"Write {content!r} to {path_file}",
+        )
+        cmd = write_request_handler.encode_run_script_command(
+            bin_python=sys.executable,
+            content=content,
+        )
+        item.run_script(cmd)
+        item.send_notification(
+            title=f"Write {content!r} to {path_file}",
+            subtitle="success",
+        )
+        sf.items.append(item)
+        return sf
+
+    def parse_query(self, query: str):
+        return dict(
+            content=query,
+        )
+
+
+handler = Handler(id="write_file")

afwf_example/paths.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+
+from pathlib_mate import Path
+
+dir_python_lib = Path.dir_here(__file__)
+dir_project_root = dir_python_lib.parent
+
+PACKAGE_NAME = dir_python_lib.basename
+
+# ------------------------------------------------------------------------------
+# Alfred Related
+# ------------------------------------------------------------------------------
+dir_home = Path.home()
+dir_project_home = dir_home / ".alfred-afwf" / PACKAGE_NAME
+dir_project_home.mkdir_if_not_exists()
+
+dir_cache = dir_project_home / ".cache"
+path_settings_sqlite = dir_project_home / "settings.sqlite"
+
+path_config_json = dir_project_home / "config.json"
+
+# ------------------------------------------------------------------------------
+# Virtual Environment Related
+# ------------------------------------------------------------------------------
+dir_venv = dir_project_root / ".venv"
+dir_venv_bin = dir_venv / "bin"
+
+# virtualenv executable paths
+bin_pytest = dir_venv_bin / "pytest"
+
+# test related
+dir_htmlcov = dir_project_root / "htmlcov"
+path_cov_index_html = dir_htmlcov / "index.html"
+dir_unit_test = dir_project_root / "tests"
+dir_int_test = dir_project_root / "tests_int"

afwf_example/settings.py

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+
+import enum
+from sqlitedict import SqliteDict
+
+from .paths import path_settings_sqlite
+
+settings = SqliteDict(path_settings_sqlite.abspath, autocommit=True)
+
+class SettingsKeyEnum(str, enum.Enum):
+    email = "email"
+    password = "password"

afwf_example/vendor/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+

afwf_example/vendor/pytest_cov_helper.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+import contextlib
+import subprocess
+from pathlib import Path
+
+
+@contextlib.contextmanager
+def temp_cwd(path: Path):
+    """
+    Temporarily set the current working directory (CWD) and automatically
+    switch back when it's done.
+    """
+    cwd = os.getcwd()
+    os.chdir(str(path))
+    try:
+        yield path
+    finally:
+        os.chdir(cwd)
+
+
+def run_cov_test(
+    script: str,
+    module: str,
+    root_dir: str,
+    htmlcov_dir: str,
+    preview: bool = False,
+    is_folder: bool = False,
+):
+    """
+    The pytest-cov plugin gives you the coverage for entire project. What if
+    I want run per-module test independently and get per-module coverage?
+
+    This is a simple wrapper around pytest + coverage cli command. Allow you to run
+    coverage test from Python script and set the code coverage measurement scope.
+
+    Usage example:
+
+    suppose you have a source code folder structure like this::
+
+        /dir_git_repo/
+        /dir_git_repo/my_library
+        /dir_git_repo/my_library/__init__.py
+        /dir_git_repo/my_library/module1.py
+        /dir_git_repo/my_library/module2.py
+
+    In your module 1 unit test script, you can do this:
+
+    .. code-block:: python
+
+        from my_library.module1 import func1, func2
+
+        def test_func1():
+            pass
+
+        def test_func2():
+            pass
+
+        if __name__ == "__main__":
+            from fixa.pytest_cov_helper import run_cov_test
+
+            run_cov_test(
+                script=__file__,
+                module="my_library.module1", # test scope is the module1.py
+                root_dir="/path/to/dir_git_repo",
+                htmlcov_dir="/path/to/dir_git_repo/htmlcov",
+            )
+
+    In your all modules unit test script, you can do this:
+
+    .. code-block:: python
+
+        if __name__ == "__main__":
+            from fixa.pytest_cov_helper import run_cov_test
+
+            run_cov_test(
+                script=__file__,
+                module="my_library", # test scope is the my_library/
+                root_dir="/path/to/dir_git_repo",
+                htmlcov_dir="/path/to/dir_git_repo/htmlcov",
+                is_folder=True, # my_library is a folder
+            )
+
+    :param script: the path to test script
+    :param module: the dot notation to the python module you want to calculate
+        coverage
+    :param root_dir: the dir to dump coverage results binary file
+    :param htmlcov_dir: the dir to dump HTML output
+    :param preview: whether to open the HTML output in web browser after the test
+    :param is_folder: whether the module is a folder
+
+    Reference:
+
+    - https://pypi.org/project/pytest-cov/
+    """
+    bin_pytest = Path(sys.executable).parent / "pytest"
+    if is_folder:
+        script = f"{Path(script).parent}"
+    if module.endswith(".py"):  # pragma: no cover
+        module = module[:-3]
+    args = [
+        f"{bin_pytest}",
+        "-s",
+        "--tb=native",
+        f"--rootdir={root_dir}",
+        f"--cov={module}",
+        "--cov-report",
+        "term-missing",
+        "--cov-report",
+        f"html:{htmlcov_dir}",
+        script,
+    ]
+    with temp_cwd(Path(root_dir)):
+        subprocess.run(args)
+    if preview:  # pragma: no cover
+        platform = sys.platform
+        if platform in ["win32", "cygwin"]:
+            open_command = "start"
+        elif platform in ["darwin", "linux"]:
+            open_command = "open"
+        else:
+            raise NotImplementedError
+        subprocess.run([open_command, f"{Path(htmlcov_dir).joinpath('index.html')}"])

afwf_example/workflow.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+
+import afwf
+
+from .handlers import (
+    open_url,
+    open_file,
+    write_file,
+    read_file,
+    error,
+    memorize_cache,
+    set_settings,
+    view_settings,
+)
+
+wf = afwf.Workflow()
+wf.register(open_url.handler)
+wf.register(open_file.handler)
+wf.register(write_file.write_request_handler)
+wf.register(write_file.handler)
+wf.register(read_file.handler)
+wf.register(error.handler)
+wf.register(memorize_cache.handler)
+wf.register(set_settings.handler)
+wf.register(set_settings.set_setting_value_handler)
+wf.register(view_settings.handler)

afwf_example-0.1.1.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: afwf_example
+Version: 0.1.1
+Summary: A sample Alfred Workflow Python project.
+Author-email: Sanhe Hu <husanhe@email.com>
+Maintainer-email: Sanhe Hu <husanhe@email.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/MacHu-GWU/afwf_example-project
+Project-URL: Documentation, https://afwf-example.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/MacHu-GWU/afwf_example-project
+Project-URL: Issues, https://github.com/MacHu-GWU/afwf_example-project/issues
+Project-URL: Changelog, https://github.com/MacHu-GWU/afwf_example-project/blob/main/release-history.rst
+Project-URL: Download, https://pypi.org/pypi/afwf-example#files
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <4.0,>=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+License-File: AUTHORS.rst
+Requires-Dist: afwf<2.0.0,>=1.0.1
+Requires-Dist: fire<1.0.0,>=0.7.0
+Provides-Extra: dev
+Requires-Dist: rich<14.0.0,>=13.8.1; extra == "dev"
+Provides-Extra: test
+Requires-Dist: pytest<9.0.0,>=8.2.2; extra == "test"
+Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "test"
+Provides-Extra: doc
+Requires-Dist: Sphinx<8.0.0,>=7.4.7; extra == "doc"
+Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
+Requires-Dist: sphinx-design<1.0.0,>=0.6.1; extra == "doc"
+Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
+Requires-Dist: furo==2024.8.6; extra == "doc"
+Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
+Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
+Requires-Dist: nbsphinx<1.0.0,>=0.8.12; extra == "doc"
+Requires-Dist: rstobj==2.0.0; extra == "doc"
+Requires-Dist: docfly==3.0.3; extra == "doc"
+Provides-Extra: mise
+Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
+Requires-Dist: httpx<1.0.0,>=0.28.0; extra == "mise"
+Requires-Dist: tomli<3.0.0,>=2.0.0; python_version < "3.11" and extra == "mise"
+Dynamic: license-file
+
+
+.. image:: https://readthedocs.org/projects/afwf-example/badge/?version=latest
+    :target: https://afwf-example.readthedocs.io/en/latest/
+    :alt: Documentation Status
+
+.. image:: https://github.com/MacHu-GWU/afwf_example-project/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/MacHu-GWU/afwf_example-project/actions?query=workflow:CI
+
+.. image:: https://codecov.io/gh/MacHu-GWU/afwf_example-project/branch/main/graph/badge.svg
+    :target: https://codecov.io/gh/MacHu-GWU/afwf_example-project
+
+.. image:: https://img.shields.io/pypi/v/afwf-example.svg
+    :target: https://pypi.python.org/pypi/afwf-example
+
+.. image:: https://img.shields.io/pypi/l/afwf-example.svg
+    :target: https://pypi.python.org/pypi/afwf-example
+
+.. image:: https://img.shields.io/pypi/pyversions/afwf-example.svg
+    :target: https://pypi.python.org/pypi/afwf-example
+
+.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/afwf_example-project/blob/main/release-history.rst
+
+.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
+    :target: https://github.com/MacHu-GWU/afwf_example-project
+
+------
+
+.. image:: https://img.shields.io/badge/Link-API-blue.svg
+    :target: https://afwf-example.readthedocs.io/en/latest/py-modindex.html
+
+.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
+    :target: https://github.com/MacHu-GWU/afwf_example-project
+
+.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
+    :target: https://github.com/MacHu-GWU/afwf_example-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
+    :target: https://github.com/MacHu-GWU/afwf_example-project/issues
+
+.. image:: https://img.shields.io/badge/Link-Download-blue.svg
+    :target: https://pypi.org/pypi/afwf-example#files
+
+
+Welcome to ``afwf_example`` Documentation
+==============================================================================
+.. image:: https://afwf-example.readthedocs.io/en/latest/_static/afwf_example-logo.png
+    :target: https://afwf-example.readthedocs.io/en/latest/
+
+This project demonstrates best practices for building Alfred Workflows using the `afwf <https://github.com/MacHu-GWU/afwf-project>`_ framework. You can use it as a reference to learn how ``afwf`` works. A `cookiecutter-afwf <https://github.com/MacHu-GWU/cookiecutter-afwf>`_ project template is also available — simply provide a project name and it will generate a ready-to-use Git repository with all the automation scripts and example code you need.

afwf_example-0.1.1.dist-info/RECORD

@@ -0,0 +1,25 @@
+afwf_example/__init__.py,sha256=iwhKnzeBJLKxpRVjvzwiRE63_zNpIBfaKLITauVph-0,24
+afwf_example/cache.py,sha256=uNlhEjtVE3_Gct0NgZLgMSl-XPZicd03VOCIDiUabEU,158
+afwf_example/cli.py,sha256=gsm0dRrnFH6H4n2F_zZKmzV3pp2c8WvQ4s5diWwXpxc,352
+afwf_example/paths.py,sha256=_dmFHiHXx9jTW9GaUjqQLb1Csdca9glNUHR_vqGqN_I,1162
+afwf_example/settings.py,sha256=ioVAV9BmKLKU4UGM9sq5aoFAZzejVSOgMFEt5ncNBW8,268
+afwf_example/workflow.py,sha256=w_v_lDFlF_BZVS7yygj5ahHlrbeEwotrsucyfPVjoV4,568
+afwf_example/handlers/__init__.py,sha256=O9CT1B2F-cVB8elT0EoCJbgkcffjvlmqteqavs4giDg,25
+afwf_example/handlers/error.py,sha256=S9pW5YqR2hGFUIO3k7vgN_D2Vl3JJk3JISYOOoiRy8I,475
+afwf_example/handlers/memorize_cache.py,sha256=rbel01gHmVCVhSe1gRQViy8DNh8u7WR8pU9uDzp_qqM,1042
+afwf_example/handlers/open_file.py,sha256=UzTBP2IJFSJNTCLmQfrf7LPXBeDRReVrdLp_cASFLSw,1706
+afwf_example/handlers/open_url.py,sha256=uEL2Y_5p9-_-DNFB1pPYmDSo-1rfexZVDrbizKF8pB8,1534
+afwf_example/handlers/open_url_new.py,sha256=vEQkd8wxQ8CgiqGwkJ76prQmKupjg4N5Ik5KFDoxC7Y,1701
+afwf_example/handlers/read_file.py,sha256=fWlKcpIvll-cokpuKy9AsTpuePIFEaArC_YaEEeKFOQ,1044
+afwf_example/handlers/set_settings.py,sha256=TSnJj1JfRvaoCxL0Eu3vAkqU7AFNvBWo_pHeJMj0Fag,3227
+afwf_example/handlers/view_settings.py,sha256=KtCeSzDkFxNY-leHZaTo8C3ctvcdMgJ55a24SNfNKzk,842
+afwf_example/handlers/write_file.py,sha256=fLA9GvSagPHspt25T2Pv8acsIBGzaO0iOwgT-M1AGBw,3027
+afwf_example/vendor/__init__.py,sha256=O9CT1B2F-cVB8elT0EoCJbgkcffjvlmqteqavs4giDg,25
+afwf_example/vendor/pytest_cov_helper.py,sha256=nR-I6d8j0P1JQy6dxIiZtG9Gz0DkfJFpk6EPCCpfnm8,3572
+afwf_example-0.1.1.dist-info/licenses/AUTHORS.rst,sha256=oo38V9AD_y57Ac69mKmiItWquV29SRi2aTCdKQo531A,767
+afwf_example-0.1.1.dist-info/licenses/LICENSE.txt,sha256=Fx_tQAmqkcvXayTPbicXlPPrnLKRf1JczCthjVuMS-M,1084
+afwf_example-0.1.1.dist-info/METADATA,sha256=SVmlEnYmaiaxLxY6Xzy6UCHJU2l1XoMgFQGSKuvTJUI,5035
+afwf_example-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+afwf_example-0.1.1.dist-info/entry_points.txt,sha256=Qatph6CdIhqH_OgAnF2oPvoPqQSybe9J9ankukEea8E,55
+afwf_example-0.1.1.dist-info/top_level.txt,sha256=w9I2FP8QqZ-2tA2J-84SFqXioZvNxBK4xMpdpKR2S7o,13
+afwf_example-0.1.1.dist-info/RECORD,,

afwf_example-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

afwf_example-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+afwf-example = afwf_example.cli:main

afwf_example-0.1.1.dist-info/licenses/AUTHORS.rst

@@ -0,0 +1,15 @@
+.. _about_author:
+
+About the Author
+------------------------------------------------------------------------------
+::
+
+   (\ (\
+   ( -.-)o
+   o_(")(")
+
+**Sanhe Hu** is a seasoned software engineer with a deep passion for Python development since 2010. As an author and maintainer of `150+ open-source Python projects <https://pypi.org/user/machugwu/>`_, with over `15 million monthly downloads <https://github.com/MacHu-GWU>`_, I bring a wealth of experience to the table. As a Senior Solution Architect and Subject Matter Expert in AI, Data, Amazon Web Services, Cloud Engineering, DevOps, I thrive on helping clients with platform design, enterprise architecture, and strategic roadmaps.
+
+Talk is cheap, show me the code:
+
+- My Github: https://github.com/MacHu-GWU

afwf_example-0.1.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sanhe Hu <husanhe@email.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

afwf_example-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+afwf_example