Update readme and add information.

This commit is contained in:
Zenohm 2016-05-14 18:09:28 -04:00
parent bb3ee3cdc3
commit 8ee1dd0e09

View File

@ -8,15 +8,15 @@ v2.0 API. This project is hosted on `Github
Installation Installation
============ ============
This library is released to PyPI, so the easiest way to install it is to use This library is released to PyPI - the Python Package Index, so the easiest way to install it is to use
easy_install:: pip::
easy_install wolframalpha
or pip::
pip install wolframalpha pip install wolframalpha
or easy_install::
easy_install wolframalpha
If you don't have these tools or you prefer not to use setuptools, you may If you don't have these tools or you prefer not to use setuptools, you may
also simply extract the 'wolframalpha' directory an appropriate location in also simply extract the 'wolframalpha' directory an appropriate location in
your Python path. your Python path.
@ -34,13 +34,19 @@ Then, you can send queries, which return Result objects::
res = client.query('temperature in Washington, DC on October 3, 2012') res = client.query('temperature in Washington, DC on October 3, 2012')
Result objects have `pods` attribute (a Pod is an answer from Wolfram Alpha):: Result objects have `pods` (a Pod is an answer group from Wolfram Alpha)::
for pod in res.pods: for pod in res.pods:
do_something_with(pod) do_something_with(pod)
You may also query for simply the pods which have 'Result' titles:: Pod objects have `subpods` (a Subpod is a specific response with the plaintext reply and some additional info)::
print(next(res.results).text) for pod in res.pods:
for sub in pod:
print(sub.text)
You may also query for simply the pods which have 'Result' titles or are marked as 'primary'::
print(res.results[0])
For more information, read the source. For more information, read the source.