-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
780 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
Metadata-Version: 1.1 | ||
Name: Alfred-Workflow | ||
Version: 1.15.3 | ||
Summary: Full-featured helper library for writing Alfred 2 workflows | ||
Home-page: http://www.deanishe.net/alfred-workflow/ | ||
Author: Dean Jackson | ||
Author-email: [email protected] | ||
License: UNKNOWN | ||
Description: | ||
A Python helper library for writing `Alfred 2`_ workflows. | ||
|
||
Alfred workflows typically take user input, fetch data from the Web or | ||
elsewhere, filter them and display results to the user. Alfred-Workflow | ||
takes care of a lot of the details for you, allowing you to concentrate your | ||
efforts on your workflow's functionality. | ||
|
||
Features | ||
======== | ||
|
||
* Catches and logs workflow errors for easier development and support | ||
* "Magic" arguments to help development/debugging | ||
* Auto-saves settings | ||
* Super-simple data caching | ||
* Fuzzy, Alfred-like search/filtering with diacritic folding | ||
* Keychain support for secure storage (and syncing) of passwords, API keys etc. | ||
* Simple generation of Alfred feedback (XML output) | ||
* Input/output decoding for handling non-ASCII text | ||
* Lightweight web API with modelled on `requests`_ | ||
* Pre-configured logging | ||
* Painlessly add directories to ``sys.path`` | ||
* Easily launch background tasks (daemons) to keep your workflow responsive | ||
* Check for new versions and update workflows hosted on GitHub. | ||
|
||
Quick Example | ||
============= | ||
|
||
Here's how to show recent `Pinboard.in <https://pinboard.in/>`_ posts in Alfred. | ||
|
||
Create a new workflow in Alfred's preferences. Add a **Script Filter** with | ||
Language ``/usr/bin/python`` and paste the following into the **Script** field | ||
(changing ``API_KEY``): | ||
|
||
.. code-block:: python | ||
|
||
import sys | ||
from workflow import Workflow, ICON_WEB, web | ||
|
||
API_KEY = 'your-pinboard-api-key' | ||
|
||
def main(wf): | ||
url = 'https://api.pinboard.in/v1/posts/recent' | ||
params = dict(auth_token=API_KEY, count=20, format='json') | ||
r = web.get(url, params) | ||
r.raise_for_status() | ||
for post in r.json()['posts']: | ||
wf.add_item(post['description'], post['href'], arg=post['href'], | ||
uid=post['hash'], valid=True, icon=ICON_WEB) | ||
wf.send_feedback() | ||
|
||
|
||
if __name__ == u"__main__": | ||
wf = Workflow() | ||
sys.exit(wf.run(main)) | ||
|
||
|
||
Add an **Open URL** action to your workflow with ``{query}`` as the **URL**, | ||
connect your **Script Filter** to it, and you can now hit **ENTER** on a | ||
Pinboard item in Alfred to open it in your browser. | ||
|
||
Installation | ||
============ | ||
|
||
**Note**: If you intend to distribute your workflow to other users, you should | ||
include Alfred-Workflow (and other Python libraries your workflow requires) | ||
within your workflow's directory as described below. **Do not** ask users to | ||
install anything into their system Python. Python installations cannot support | ||
multiple versions of the same library, so if you rely on globally-installed | ||
libraries, the chances are very good that your workflow will sooner or later | ||
break—or be broken by—some other software doing the same naughty thing. | ||
|
||
With pip | ||
-------- | ||
|
||
You can install Alfred-Workflow directly into your workflow with:: | ||
|
||
pip install --target=/path/to/my/workflow Alfred-Workflow | ||
|
||
You can install any other library available on the `Cheese Shop`_ the | ||
same way. See the `pip documentation`_ for more information. | ||
|
||
From source | ||
----------- | ||
|
||
Download the ``alfred-workflow-X.X.X.zip`` file from the `GitHub releases`_ page | ||
and either extract the ZIP to the root directory of your workflow (where | ||
``info.plist`` is) or place the ZIP in the root directory and add | ||
``sys.path.insert(0, 'alfred-workflow-X.X.X.zip')`` to the top of your | ||
Python scripts. | ||
|
||
Alternatively, you can download `the source code`_ from the `GitHub repository`_ | ||
and copy the ``workflow`` subfolder to the root directory of your workflow. | ||
|
||
Your workflow directory should look something like this (where | ||
``yourscript.py`` contains your workflow code and ``info.plist`` is | ||
the workflow information file generated by Alfred):: | ||
|
||
Your Workflow/ | ||
info.plist | ||
icon.png | ||
workflow/ | ||
__init__.py | ||
background.py | ||
update.py | ||
version | ||
web.py | ||
workflow.py | ||
yourscript.py | ||
etc. | ||
|
||
|
||
Or like this:: | ||
|
||
Your Workflow/ | ||
info.plist | ||
icon.png | ||
workflow-1.X.X.zip | ||
yourscript.py | ||
etc. | ||
|
||
Documentation | ||
============= | ||
|
||
Detailed documentation, including a tutorial, is available at | ||
http://www.deanishe.net/alfred-workflow/. | ||
|
||
.. _requests: http://docs.python-requests.org/en/latest/ | ||
.. _Alfred 2: http://www.alfredapp.com/ | ||
.. _GitHub releases: https://github.com/deanishe/alfred-workflow/releases | ||
.. _the source code: https://github.com/deanishe/alfred-workflow/archive/master.zip | ||
.. _GitHub repository: https://github.com/deanishe/alfred-workflow | ||
.. _Cheese Shop: https://pypi.python.org/pypi | ||
.. _pip documentation: https://pip.pypa.io/en/latest/ | ||
|
||
Keywords: alfred workflow | ||
Platform: UNKNOWN | ||
Classifier: Development Status :: 5 - Production/Stable | ||
Classifier: License :: OSI Approved :: MIT License | ||
Classifier: Operating System :: MacOS :: MacOS X | ||
Classifier: Intended Audience :: Developers | ||
Classifier: Natural Language :: English | ||
Classifier: Programming Language :: Python :: 2.6 | ||
Classifier: Programming Language :: Python :: 2.7 | ||
Classifier: Topic :: Software Development :: Libraries | ||
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
MANIFEST.in | ||
README.rst | ||
setup.cfg | ||
setup.py | ||
Alfred_Workflow.egg-info/PKG-INFO | ||
Alfred_Workflow.egg-info/SOURCES.txt | ||
Alfred_Workflow.egg-info/dependency_links.txt | ||
Alfred_Workflow.egg-info/not-zip-safe | ||
Alfred_Workflow.egg-info/top_level.txt | ||
workflow/Notify.tgz | ||
workflow/__init__.py | ||
workflow/background.py | ||
workflow/notify.py | ||
workflow/update.py | ||
workflow/version | ||
workflow/web.py | ||
workflow/workflow.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
20 changes: 20 additions & 0 deletions
20
src/Alfred_Workflow-1.15.3-py3.4.egg-info/installed-files.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
../workflow/__init__.py | ||
../workflow/background.py | ||
../workflow/notify.py | ||
../workflow/update.py | ||
../workflow/web.py | ||
../workflow/workflow.py | ||
../workflow/Notify.tgz | ||
../workflow/version | ||
../workflow/__pycache__/__init__.cpython-34.pyc | ||
../workflow/__pycache__/background.cpython-34.pyc | ||
../workflow/__pycache__/notify.cpython-34.pyc | ||
../workflow/__pycache__/update.cpython-34.pyc | ||
../workflow/__pycache__/web.cpython-34.pyc | ||
../workflow/__pycache__/workflow.cpython-34.pyc | ||
. | ||
dependency_links.txt | ||
not-zip-safe | ||
PKG-INFO | ||
SOURCES.txt | ||
top_level.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
workflow |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
Metadata-Version: 1.1 | ||
Name: Alfred-Workflow | ||
Version: 1.17.2 | ||
Summary: Full-featured helper library for writing Alfred 2 workflows | ||
Home-page: http://www.deanishe.net/alfred-workflow/ | ||
Author: Dean Jackson | ||
Author-email: [email protected] | ||
License: UNKNOWN | ||
Description: | ||
A Python helper library for writing `Alfred 2`_ workflows. | ||
|
||
Alfred workflows typically take user input, fetch data from the Web or | ||
elsewhere, filter them and display results to the user. Alfred-Workflow | ||
takes care of a lot of the details for you, allowing you to concentrate your | ||
efforts on your workflow's functionality. | ||
|
||
http://www.deanishe.net/alfred-workflow/ | ||
|
||
|
||
Features | ||
======== | ||
|
||
* Catches and logs workflow errors for easier development and support | ||
* "Magic" arguments to help development/debugging | ||
* Auto-saves settings | ||
* Super-simple data caching | ||
* Fuzzy, Alfred-like search/filtering with diacritic folding | ||
* Keychain support for secure storage (and syncing) of passwords, API keys etc. | ||
* Simple generation of Alfred feedback (XML output) | ||
* Input/output decoding for handling non-ASCII text | ||
* Lightweight web API with modelled on `requests`_ | ||
* Pre-configured logging | ||
* Painlessly add directories to ``sys.path`` | ||
* Easily launch background tasks (daemons) to keep your workflow responsive | ||
* Check for new versions and update workflows hosted on GitHub. | ||
* Post notifications via Notification Center. | ||
|
||
|
||
Quick Example | ||
============= | ||
|
||
Here's how to show recent `Pinboard.in <https://pinboard.in/>`_ posts | ||
in Alfred. | ||
|
||
Create a new workflow in Alfred's preferences. Add a **Script Filter** with | ||
Language ``/usr/bin/python`` and paste the following into the **Script** | ||
field (changing ``API_KEY``): | ||
|
||
|
||
.. code-block:: python | ||
|
||
import sys | ||
from workflow import Workflow, ICON_WEB, web | ||
|
||
API_KEY = 'your-pinboard-api-key' | ||
|
||
def main(wf): | ||
url = 'https://api.pinboard.in/v1/posts/recent' | ||
params = dict(auth_token=API_KEY, count=20, format='json') | ||
r = web.get(url, params) | ||
r.raise_for_status() | ||
for post in r.json()['posts']: | ||
wf.add_item(post['description'], post['href'], arg=post['href'], | ||
uid=post['hash'], valid=True, icon=ICON_WEB) | ||
wf.send_feedback() | ||
|
||
|
||
if __name__ == u"__main__": | ||
wf = Workflow() | ||
sys.exit(wf.run(main)) | ||
|
||
|
||
Add an **Open URL** action to your workflow with ``{query}`` as the **URL**, | ||
connect your **Script Filter** to it, and you can now hit **ENTER** on a | ||
Pinboard item in Alfred to open it in your browser. | ||
|
||
|
||
Installation | ||
============ | ||
|
||
**Note**: If you intend to distribute your workflow to other users, you | ||
should include Alfred-Workflow (and other Python libraries your workflow | ||
requires) within your workflow's directory as described below. **Do not** | ||
ask users to install anything into their system Python. Python installations | ||
cannot support multiple versions of the same library, so if you rely on | ||
globally-installed libraries, the chances are very good that your workflow | ||
will sooner or later break—or be broken by—some other software doing the | ||
same naughty thing. | ||
|
||
|
||
With pip | ||
-------- | ||
|
||
You can install Alfred-Workflow directly into your workflow with:: | ||
|
||
pip install --target=/path/to/my/workflow Alfred-Workflow | ||
|
||
You can install any other library available on the `Cheese Shop`_ the | ||
same way. See the `pip documentation`_ for more information. | ||
|
||
|
||
From source | ||
----------- | ||
|
||
Download the ``alfred-workflow-X.X.X.zip`` file from the `GitHub releases`_ page | ||
and either extract the ZIP to the root directory of your workflow (where | ||
``info.plist`` is) or place the ZIP in the root directory and add | ||
``sys.path.insert(0, 'alfred-workflow-X.X.X.zip')`` to the top of your | ||
Python scripts. | ||
|
||
Alternatively, you can download `the source code`_ from the `GitHub repository`_ | ||
and copy the ``workflow`` subfolder to the root directory of your workflow. | ||
|
||
Your workflow directory should look something like this (where | ||
``yourscript.py`` contains your workflow code and ``info.plist`` is | ||
the workflow information file generated by Alfred):: | ||
|
||
Your Workflow/ | ||
info.plist | ||
icon.png | ||
workflow/ | ||
__init__.py | ||
background.py | ||
notify.py | ||
Notify.tgz | ||
update.py | ||
version | ||
web.py | ||
workflow.py | ||
yourscript.py | ||
etc. | ||
|
||
|
||
Or like this:: | ||
|
||
Your Workflow/ | ||
info.plist | ||
icon.png | ||
workflow-1.X.X.zip | ||
yourscript.py | ||
etc. | ||
|
||
|
||
Documentation | ||
============= | ||
|
||
Detailed documentation, including a tutorial, is available at | ||
http://www.deanishe.net/alfred-workflow/. | ||
|
||
.. _requests: http://docs.python-requests.org/en/latest/ | ||
.. _Alfred 2: http://www.alfredapp.com/ | ||
.. _GitHub releases: https://github.com/deanishe/alfred-workflow/releases | ||
.. _the source code: https://github.com/deanishe/alfred-workflow/archive/master.zip | ||
.. _GitHub repository: https://github.com/deanishe/alfred-workflow | ||
.. _Cheese Shop: https://pypi.python.org/pypi | ||
.. _pip documentation: https://pip.pypa.io/en/latest/ | ||
|
||
Keywords: alfred workflow | ||
Platform: UNKNOWN | ||
Classifier: Development Status :: 5 - Production/Stable | ||
Classifier: License :: OSI Approved :: MIT License | ||
Classifier: Operating System :: MacOS :: MacOS X | ||
Classifier: Intended Audience :: Developers | ||
Classifier: Natural Language :: English | ||
Classifier: Programming Language :: Python :: 2.6 | ||
Classifier: Programming Language :: Python :: 2.7 | ||
Classifier: Topic :: Software Development :: Libraries | ||
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
MANIFEST.in | ||
README_PYPI.rst | ||
setup.cfg | ||
setup.py | ||
Alfred_Workflow.egg-info/PKG-INFO | ||
Alfred_Workflow.egg-info/SOURCES.txt | ||
Alfred_Workflow.egg-info/dependency_links.txt | ||
Alfred_Workflow.egg-info/not-zip-safe | ||
Alfred_Workflow.egg-info/top_level.txt | ||
workflow/Notify.tgz | ||
workflow/__init__.py | ||
workflow/background.py | ||
workflow/notify.py | ||
workflow/update.py | ||
workflow/version | ||
workflow/web.py | ||
workflow/workflow.py |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
Oops, something went wrong.