.. .. 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
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/afwf_shell-project",
"name": "afwf-shell",
"maintainer": "Sanhe Hu",
"docs_url": null,
"requires_python": "",
"maintainer_email": "husanhe@gmail.com",
"keywords": "",
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/65/3c20720c2d71c4ba8143c09453fffcebbf4aa7db80e63892504dbf72b7ba/afwf_shell-0.0.7.tar.gz",
"platform": "Windows",
"description": "\n.. .. image:: https://readthedocs.org/projects/afwf-shell/badge/?version=latest\n :target: https://afwf-shell.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/afwf_shell-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/afwf_shell-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/afwf_shell-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/afwf_shell-project\n\n.. image:: https://img.shields.io/pypi/v/afwf-shell.svg\n :target: https://pypi.python.org/pypi/afwf-shell\n\n.. image:: https://img.shields.io/pypi/l/afwf-shell.svg\n :target: https://pypi.python.org/pypi/afwf-shell\n\n.. image:: https://img.shields.io/pypi/pyversions/afwf-shell.svg\n :target: https://pypi.python.org/pypi/afwf-shell\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/afwf_shell-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/afwf_shell-project\n\n------\n\n.. .. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://afwf-shell.readthedocs.io/en/latest/\n\n.. .. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://afwf-shell.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/afwf_shell-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/afwf_shell-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/afwf_shell-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/afwf-shell#files\n\n\nWelcome to ``afwf_shell`` Documentation\n==============================================================================\n``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>`_.\n\nDemo:\n\n.. image:: https://github.com/MacHu-GWU/afwf_shell-project/assets/6800411/d242f01d-3921-42ba-a14c-c150a53514f6\n\nExamples:\n\n- `ui_example.py <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/ui_example.py>`_\n- `error_handling_example_1 <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/error_handling_example_1.py>`_\n- `error_handling_example_2 <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/error_handling_example_2.py>`_\n- `first_run_waiter_example.py <https://github.com/MacHu-GWU/afwf_shell-project/blob/main/examples/first_run_waiter_example.py>`_\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``afwf_shell`` is released on PyPI, so all you need is to:\n\n.. code-block:: console\n\n $ pip install afwf-shell\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade afwf-shell\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Alfred Workflow Shell Simulator.",
"version": "0.0.7",
"project_urls": {
"Download": "https://pypi.python.org/pypi/afwf_shell/0.0.7#downloads",
"Homepage": "https://github.com/MacHu-GWU/afwf_shell-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e9474030d9d7b8a4f6a5b49d6ebae931d18b04cd7092a465cc28d6ffed98c69",
"md5": "527fa375bd0622c8a9f31b57e2b97417",
"sha256": "c5ca2f5079213f14199b30215338e7a87599cf8487db55352337992a649a5e46"
},
"downloads": -1,
"filename": "afwf_shell-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "527fa375bd0622c8a9f31b57e2b97417",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 34947,
"upload_time": "2023-10-12T18:15:29",
"upload_time_iso_8601": "2023-10-12T18:15:29.370521Z",
"url": "https://files.pythonhosted.org/packages/1e/94/74030d9d7b8a4f6a5b49d6ebae931d18b04cd7092a465cc28d6ffed98c69/afwf_shell-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0f653c20720c2d71c4ba8143c09453fffcebbf4aa7db80e63892504dbf72b7ba",
"md5": "136d315891644d032869e09f47239503",
"sha256": "47b672e0a35d201cb78f96d269dbd755693ef7ba11f91fe2f55c2500a5032c8b"
},
"downloads": -1,
"filename": "afwf_shell-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "136d315891644d032869e09f47239503",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31182,
"upload_time": "2023-10-12T18:15:31",
"upload_time_iso_8601": "2023-10-12T18:15:31.218048Z",
"url": "https://files.pythonhosted.org/packages/0f/65/3c20720c2d71c4ba8143c09453fffcebbf4aa7db80e63892504dbf72b7ba/afwf_shell-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 18:15:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "afwf_shell-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "afwf-shell"
}
JSON
