afwf-shell

.. .. image:: https://readthedocs.org/projects/afwf-shell/badge/?version=latest
    :target: https://afwf-shell.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/afwf_shell-project/workflows/CI/badge.svg
    :target: https://github.com/MacHu-GWU/afwf_shell-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/afwf_shell-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/afwf_shell-project

.. image:: https://img.shields.io/pypi/v/afwf-shell.svg
    :target: https://pypi.python.org/pypi/afwf-shell

.. image:: https://img.shields.io/pypi/l/afwf-shell.svg
    :target: https://pypi.python.org/pypi/afwf-shell

.. image:: https://img.shields.io/pypi/pyversions/afwf-shell.svg
    :target: https://pypi.python.org/pypi/afwf-shell

.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/afwf_shell-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
    :target: https://github.com/MacHu-GWU/afwf_shell-project

------

.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg
    :target: https://afwf-shell.readthedocs.io/en/latest/

.. .. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://afwf-shell.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/afwf_shell-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/afwf_shell-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/afwf_shell-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/afwf-shell#files


Welcome to ``afwf_shell`` Documentation
==============================================================================
``afwf_shell`` is a framework for building Alfred Workflow liked App in terminal. See example at `ui_example.py <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/ui_example.py>`_.

Demo:

.. image:: https://github.com/MacHu-GWU/afwf_shell-project/assets/6800411/d242f01d-3921-42ba-a14c-c150a53514f6

Examples:

- `ui_example.py <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/ui_example.py>`_
- `error_handling_example_1 <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/error_handling_example_1.py>`_
- `error_handling_example_2 <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/error_handling_example_2.py>`_
- `first_run_waiter_example.py <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/first_run_waiter_example.py>`_


.. _install:

Install
------------------------------------------------------------------------------

``afwf_shell`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install afwf-shell

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade afwf-shell