Metadata-Version: 2.4
Name: afwf_home_documents_github
Version: 0.1.1
Summary: An Alfred workflow for indexing and acting on repos under ~/Documents/GitHub.
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_home_documents_github-project
Project-URL: Documentation, https://afwf-home-documents-github.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/MacHu-GWU/afwf_home_documents_github-project
Project-URL: Issues, https://github.com/MacHu-GWU/afwf_home_documents_github-project/issues
Project-URL: Changelog, https://github.com/MacHu-GWU/afwf_home_documents_github-project/blob/main/release-history.rst
Project-URL: Download, https://pypi.org/pypi/afwf-home-documents-github#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.2
Requires-Dist: fire<1.0.0,>=0.6.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-home-documents-github/badge/?version=latest
    :target: https://afwf-home-documents-github.readthedocs.io/en/latest/
    :alt: Documentation Status

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

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

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

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

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

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/afwf_home_documents_github-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_home_documents_github-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://afwf-home-documents-github.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_home_documents_github-project

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

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

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


Welcome to ``afwf_home_documents_github`` Documentation
==============================================================================
.. image:: https://afwf-home-documents-github.readthedocs.io/en/latest/_static/afwf_home_documents_github-logo.png
    :target: https://afwf-home-documents-github.readthedocs.io/en/latest/

An `Alfred <https://www.alfredapp.com/>`_ workflow for indexing and acting on repos under ``~/Documents/GitHub``.

All of the user's git repos are backed up as top-level folders directly under ``~/Documents/GitHub``. Every feature in this workflow starts from the same place: pick a top-level repo folder under that root, then do something with it. Today there are two keywords:

- ``files`` — search for any file or folder inside the selected repo, then open it or reveal it in Finder.
- ``ccc`` — open a new terminal tab in the selected repo and start a Claude Code session there.

For how each keyword works end-to-end, and the tools it depends on, see the "How the Workflow Works" section in the full documentation.


.. _install:

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

This package is not on PyPI yet — it's used locally as the CLI that backs this Alfred workflow's Script Filter nodes (see ``info.plist``). Clone the repo and install it into its own virtual environment:

.. code-block:: console

    $ mise run inst

That installs the ``afwf-home-documents-github`` console script into ``.venv/bin/``, which each Script Filter node calls directly during development. Once this is published to PyPI, the usual install will also work:

.. code-block:: console

    $ pip install afwf-home-documents-github

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade afwf-home-documents-github
