Version 1.0.2
[python-thefuckingweather.git] / README
blobeb399253f646f360bdaa91cfb8f83ef612e09126
1 Python API for The Fucking Weather, version 1.0
2 Copyright (C) 2009  Ian Weller <ian@ianweller.org>
3 http://ianweller.org/thefuckingweather
5 This program is free software. It comes without any warranty, to
6 the extent permitted by applicable law. You can redistribute it
7 and/or modify it under the terms of the Do What The Fuck You Want
8 To Public License, Version 2, as published by Sam Hocevar. See
9 http://sam.zoy.org/wtfpl/COPYING for more details.
11 ----
13 I wrote this mainly for fun. The implementation is ridiculously thorough
14 out of irony, up to the point of writing specific error classes -- but
15 be glad I wasn't insane enough to create a new class for the data. (Even
16 though I easily could have.)
18 The code is self-documenting so you shouldn't have any problem using it.
19 The basic way to use it, if you're including it in a program, is:
21 >>> import thefuckingweather
22 >>> thefuckingweather.get_weather("Wichita, KS")
24 and you'll get lots of return data. The data format is documented under
25 get_weather(). You can also run it from a shell: this output is pretty
26 to the average user but can also be parsed by the likes of sed.
28 The Git repository is located on GitHub:
29   https://github.com/ianweller/python-thefuckingweather
31 This program comes without any warranty (as stated in the copyright
32 disclaimer), so please don't treat it as an actual weather reporting
33 system or as trustworthy.
35 Enjoy!