From 9201cf2210dc749fcce88d7bc72239813a02ff83 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Tue, 24 Nov 2015 20:23:25 -0500 Subject: [PATCH] Move existing readme into canonical location --- README | 46 ---------------------------------------------- README.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 46 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index 79f17c8..0000000 --- a/README +++ /dev/null @@ -1,46 +0,0 @@ -wolframalpha -============ - -Python Client built against the `Wolfram|Alpha `_ -v2.0 API. This project is hosted on `bitbucket -`_. - -Installation -============ - -This library is released to PyPI, so the easiest way to install it is to use -easy_install:: - - easy_install wolframalpha - -or pip:: - - pip install wolframalpha - -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 -your Python path. - -Usage -===== - -Basic usage is pretty simple. Create the client with your App ID (request from -Wolfram Alpha):: - - import wolframalpha - client = wolframalpha.Client(app_id) - -Then, you can send queries, which return Result objects:: - - res = client.query('temperature in Washington, DC on October 3, 2012') - -Result objects have `pods` attribute (a Pod is an answer from Wolfram Alpha):: - - for pod in res.pods: - do_something_with(pod) - -You may also query for simply the pods which have 'Result' titles:: - - print(next(res.results).text) - -For more information, read the source. diff --git a/README.txt b/README.txt index e9a79e0..79f17c8 100644 --- a/README.txt +++ b/README.txt @@ -1,2 +1,46 @@ wolframalpha ============ + +Python Client built against the `Wolfram|Alpha `_ +v2.0 API. This project is hosted on `bitbucket +`_. + +Installation +============ + +This library is released to PyPI, so the easiest way to install it is to use +easy_install:: + + easy_install wolframalpha + +or pip:: + + pip install wolframalpha + +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 +your Python path. + +Usage +===== + +Basic usage is pretty simple. Create the client with your App ID (request from +Wolfram Alpha):: + + import wolframalpha + client = wolframalpha.Client(app_id) + +Then, you can send queries, which return Result objects:: + + res = client.query('temperature in Washington, DC on October 3, 2012') + +Result objects have `pods` attribute (a Pod is an answer from Wolfram Alpha):: + + for pod in res.pods: + do_something_with(pod) + +You may also query for simply the pods which have 'Result' titles:: + + print(next(res.results).text) + +For more information, read the source.