diff --git a/README b/README new file mode 100644 index 0000000..e2fe50a --- /dev/null +++ b/README @@ -0,0 +1,25 @@ +wolframalpha +============ + +Python Client built against the `Wolfram|Alpha `_ +v2.0 API. + +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). +You may also query for simple the pods which have 'Result' titles:: + + print(res.results[0].text) + +For more information, read the source. diff --git a/setup.py b/setup.py index f13817d..2478fc1 100644 --- a/setup.py +++ b/setup.py @@ -2,10 +2,14 @@ # Generated by jaraco.develop (https://bitbucket.org/jaraco/jaraco.develop) import setuptools +with open('README') as f: + long_description = f.read() + setup_params = dict( name='wolframalpha', - description="Wolfram|Alpha 2.0 API client", use_hg_version=True, + description="Wolfram|Alpha 2.0 API client", + long_description = long_description, author="Jason R. Coombs", author_email="jaraco@jaraco.com", url="https://bitbucket.org/jaraco/wolframalpha",