fhsu avatar fhsu committed a405ca4

Initial commit. Hooray!

Comments (0)

Files changed (31)

+syntax: glob
+*.pyc
+*.pyo
+*.egg-info
+*.egg-link
+*.png
+# ignore virtualenv folders:
+lib
+bin
+include
+# ignore build folders:
+dist
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<http://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
+PunkyBrowster
+=============
+
+PunkyBrowster is a programmatic browser with a synchronous API. It is a fork of
+the spynner project. We remove unessential stuff like URL filtering, download
+handling, and cookie emulation. We also remove some potentially harmful stuff
+like JavaScript injection. What's left is a fairly lean core of functionality,
+and on top of that we add some convenience methods for DOM querying and event
+simulation.
+
+Links
+-----
+
+spynner: http://code.google.com/p/spynner/
+
+PyQt4 Docs: http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/pyqt4ref.html
+
+Qt 4.7 class reference: http://doc.trolltech.com/4.7/classes.html
+
+**PunkyBrowster requires that PyQt4 has already been installed.**
+
+Testing
+-------
+
+To test pre-installation::
+
+    python setup.py test
+
+Or, having met test dependencies::
+
+    python t.py
+
+Installation
+------------
+
+To install::
+
+    python setup.py install
+
+Changes
+-------
+
+0.3.1
+
+- Browster is a "new"-style class.
+- Added "status" property.
+- WebView window does not steal focus when opened.
+- Better validation for form-filling methods raises exceptions instead of failing silently.
+- Fixed issue with screen-captures being too large if previous capture was on large page.
+- Support for new HTML5 input types.

examples/form_manipulation.html

+<html>
+
+<head>
+
+    <style>
+    br { margin-bottom: 30px; }
+    </style>
+
+</head>
+
+<body>
+    <h1>Form Manipulation</h1>
+
+    <form id="my-form" action="form_manipulation_2.html">
+        <input name="title" type="text" value="foobar" />
+        <br />
+
+        <textarea name="message" rows="3">Foobar</textarea>
+        <br />
+
+        <select name="produce">
+            <option value="a">Apples</a>
+            <option value="b">Bananas</a>
+            <option value="c">Cauliflower</a>
+            <option value="d">Durian</a>
+            <option value="e">Eggplant</a>
+        </select>
+        <br />
+
+        <select name="monkeys" multiple="multiple">
+            <option value="11">Spider</a>
+            <option value="12">Capuchin</a>
+            <option value="13">Baboon</a>
+            <option value="14">Tamarin</a>
+            <option value="15">Macaque</a>
+            <option value="16">Howler</a>
+        </select>
+        <br />
+
+        <input name="show" type="radio" value="punky">Punky Brewster
+        <input name="show" type="radio" value="blossom">Blossom
+        <input name="show" type="radio" value="golden">Golden Girls
+        <br />
+
+        <input name="intoxicated" type="checkbox" />Are you super happy?
+        <br />
+
+        <input name="medicated" type="checkbox" checked="checked" />Are you super sad?
+        <br />
+
+        <input type="submit" value="Submit this form, yo" />
+    </form>
+
+</body>
+</html>

examples/form_manipulation.py

+from punky import Browster
+
+browser = Browster()
+browser.create_webview(show=True)
+
+browser.load('form_manipulation.html')
+
+# Note that the fill() method knows how to deal with unicode strings.
+browser.fill('input[name="title"]', u'I must not fear (\u6211\u4e0d\u8bb8\u6015)')
+
+browser.fill('textarea[name=message]', u'Fear is the mind killer (\u5bb3\u6015\u662f\u601d\u60f3\u7684\u6740\u624b)')
+
+# Select the third option in the select widget:
+browser.select('select[name=produce] option:nth-child(3)')
+
+# Quotes in CSS selectors are usually optional but become necessary when dealing
+# with numbers
+browser.select('select[name=monkeys] option[value="12"]')
+browser.select('select[name=monkeys] option[value="14"]')
+browser.select('select[name=monkeys] option[value="15"]')
+
+# Choose the third radio button:
+browser.choose('input[name=show][value=golden]')
+
+# Check the checkbox:
+browser.check('input[name=intoxicated]')
+
+# Uncheck the checkbox:
+browser.uncheck('input[name=medicated]')
+
+# Click the submit button:
+browser.click('input[type=submit]')

examples/form_manipulation_2.html

+<html>
+
+<head>
+
+    <script>
+    window.onload = function() {
+        var href = document.location.href;
+
+        var params = href.substr(href.indexOf('?') + 1);
+        params = params.split('&');
+
+        var results = document.getElementById('results');
+        for (var i=0; i < params.length; i++) {
+            var parts = params[i].split('=');
+            var name = parts[0];
+            var value = unescape(parts[1]);
+
+            var el = document.createElement('p');
+            el.innerHTML = name + ' = ' + value;
+            results.appendChild(el);
+        }
+    }
+    </script>
+
+</head>
+
+<body>
+    <h1>Form Manipulation Results</h1>
+
+    <div id="results"></div>
+
+</body>
+</html>

examples/hello_punky.html

+<html>
+
+<head>
+
+<style>
+p { background-color: goldenrod; padding: 8px; }
+</style>
+
+<script>
+function simulateClick() {
+    var evt = document.createEvent('MouseEvents');
+    evt.initEvent('click', true, true);
+    document.getElementById('my-anchor').dispatchEvent(evt);
+}
+
+window.onload = function() {
+    for (var i=0; i < 100; i++) {
+        var el = document.createElement('p');
+        el.innerHTML = '(' + (i+1) + ') Hello Universe!';
+        document.body.appendChild(el);
+    }
+}
+</script>
+
+</head>
+
+<body>
+
+<a id="my-anchor" href="hello_punky_2.html">Next page</a>
+
+<br /><br />
+
+<button onclick="simulateClick();">Simulate click on anchor</button>
+
+</body>
+</html>
+
+

examples/hello_punky.py

+"""
+Visit a bunch of pages, taking a snapshot of each one.
+"""
+from punky import Browster
+
+browser = Browster()
+browser.create_webview(show=True)
+
+browser.load('./hello_punky.html')
+browser.wait(3)
+browser.save_snapshot('1.png')
+
+browser.click_link('#my-anchor')
+browser.wait(3)
+browser.save_snapshot('2.png')
+
+browser.load('http://www.yahoo.com')
+browser.wait(3)
+browser.save_snapshot('3.png')
+
+browser.load('http://www.google.com')
+browser.wait(3)
+browser.save_snapshot('4.png')

examples/hello_punky_2.html

+<html>
+
+<head>
+
+<style>
+body {
+    background-color: lavenderblush;
+}
+</style>
+
+</head>
+
+<body>
+
+<div id="content">
+    <h1>Monkey Heaven</h1>
+
+    <h2>If you want a banana,</h2>
+
+    <h3>just politely request one</h3>
+
+    <h4>from the human.</h4>
+</div>
+
+</body>
+</html>

examples/hello_qt4.py

+"""
+Run this program to make sure that PyQt4 is installed properly. You should see
+a small window whose title bar reads 'Hello PyQt4!'.
+"""
+import sys
+from PyQt4 import QtGui
+
+app = QtGui.QApplication(sys.argv)
+
+widget = QtGui.QWidget()
+widget.resize(250, 150)
+widget.setWindowTitle('Hello PyQt4!')
+widget.show()
+
+sys.exit(app.exec_())

examples/hello_qwebview.py

+"""
+Run this program to make sure that the QWebView widgets works as expected.
+"""
+
+URL = './hello_punky.html'
+
+from PyQt4.QtCore import QUrl
+from PyQt4.QtGui import QApplication
+from PyQt4.QtWebKit import QWebView
+
+app = QApplication([])
+
+webview = QWebView()
+webview.setUrl(QUrl(URL))
+webview.show()
+
+app.exec_()

examples/local_html_file.py

+import os
+from punky import Browster
+
+browser = Browster()
+browser.create_webview(show=True)
+
+# This should also work fine:
+#browser.load('./mouse_click_test.html')
+
+# To use absolute paths, you need make a file:// URL:
+cwd = os.getcwd()
+url = 'file://' + cwd + '/hello_punky.html'
+browser.load(url)
+
+print browser.url

punky/__init__.py

+from browster import Browster
+
+__version__ = '0.3.1'

punky/browster.py

+# Copyright (c) Leapfrog Direct Response LLC
+#    (https://bitbucket.org/leapfrogdevelopment/)
+#
+# PunkyBrowster is a derivative work of Spynner:
+#
+#
+#    Copyright (c) Arnau Sanchez <tokland@gmail.com>
+#
+#    This script is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this software.  If not, see <http://www.gnu.org/licenses/>
+#
+#
+# PunkyBrowster was forked from the 2009-07-09 edition of Spynner.
+#
+# Additional Terms Pertaining Only to the Modified Aspects of this Software:
+# Neither the name of Leapfrog Direct Response, LLC, including its subsidiaries
+# and affiliates nor the names of its contributors, may be used to endorse or
+# promote products derived from this software without specific prior written
+# permission.
+
+
+import sys
+import time
+
+from PyQt4.QtCore import SIGNAL, QUrl, Qt, QSize
+from PyQt4.QtGui import QApplication, QImage, QPainter
+from PyQt4.QtNetwork import QNetworkRequest
+from PyQt4.QtWebKit import QWebElement, QWebPage, QWebView, QWebSettings
+
+SUPPORTED_STRING_INPUT_TYPES = ('text',
+                                'password',
+                                'datetime',
+                                'datetime-local',
+                                'date',
+                                'month',
+                                'time',
+                                'week',
+                                'number',
+                                'range',
+                                'email',
+                                'url',
+                                'search',
+                                'tel',
+                                'color')
+
+
+if sys.platform == 'darwin':
+    from PyQt4.QtCore import pyqtRemoveInputHook
+    pyqtRemoveInputHook()
+
+__all__ = ['Browster']
+
+
+def func(hey=[], dodo={}):
+    hey.append(1)
+    dodo['a'] = 3
+    return 555
+
+
+class Browster(object):
+    application = QApplication([])
+    event_looptime = 0.01
+
+    # Feihong: Does this constructor need another keyword argument for
+    # JavascriptEnabled, JavascriptCanOpenWindows?
+    # See http://doc.trolltech.com/4.6/qwebsettings.html#WebAttribute-enum
+    def __init__(self, auto_load_images=True, ignore_ssl_errors=False, webpage=None):
+        """Init a Browser instance. 'auto_load_images' is fairly self-explanatory,
+        'ignore_ssl_errors' will silence any SSL problems.
+
+        'webpage' allows you to specify your own webpage object for use with the browser.
+        By default, it uses the QWebPage object from PyQT. For details, see see:
+        http://doc.qt.nokia.com/4.5/qwebpage.html
+
+        """
+        self.webpage = webpage or QWebPage()
+
+        self.webpage.settings().setAttribute(QWebSettings.AutoLoadImages, auto_load_images)
+
+        self.webframe = self.webpage.mainFrame()
+
+        self.webview = None
+
+        self._load_status = None
+
+        self.statuses = {}
+
+        self.ignore_ssl_errors = ignore_ssl_errors
+
+        self.webpage.connect(
+            self.webpage,
+            SIGNAL('loadFinished(bool)'),
+            self._on_load_finished
+        )
+        self.webpage.connect(
+            self.webpage,
+            SIGNAL("loadStarted()"),
+            self._on_load_started
+        )
+        self.webpage.connect(
+            self.webpage.networkAccessManager(),
+            SIGNAL("sslErrors(QNetworkReply *,const QList<QSslError>&)"),
+            self._on_ssl_error
+        )
+        self.webpage.connect(
+            self.webpage.networkAccessManager(),
+            SIGNAL("finished(QNetworkReply *)"),
+            self._on_finished
+        )
+
+    def all(self, selector):
+        """Return a list of all elements in the current document that match the
+        given CSS selector.
+
+        """
+        result = self.webframe.documentElement().findAll(selector)
+
+        # The QWebElement.findAll() method returns an instance of
+        # QWebElementCollection, which is NOT iterable.
+        return [result[i] for i in xrange(result.count())]
+
+    def count(self, selector):
+        """Return the number of elements that match the given CSS selector."""
+        return self.webframe.documentElement().findAll(selector).count()
+
+    def _first(self, selector):
+        """Return the first element in the current document that matches the
+        given CSS selector.
+
+        If no element is found, raise PunkyElementNotFound exception.
+
+        """
+        el = self.webframe.documentElement().findFirst(selector)
+
+        # The QWebElement.findFirst() method ALWAYS returns an instance of
+        # QWebElement, even if no matches are found.
+        if not el.isNull():
+            return el
+        else:
+            raise PunkyElementNotFound("No page element found matching: {0}".format(selector))
+
+    def first(self, selector):
+        try:
+            return self._first(selector)
+        except PunkyElementNotFound:
+            return None
+
+    def _events_loop(self, wait=None):
+        """Let the QApplication object process some events, then sleep."""
+        if wait is None:
+            wait = self.event_looptime
+
+        self.application.processEvents()
+        time.sleep(wait)
+
+    def _on_webview_destroyed(self, window):
+        self.webview = None
+
+    def _on_load_started(self):
+        self._load_status = None
+        self.statuses.clear()
+
+    def _on_load_finished(self, successful):
+        self._load_status = successful
+
+    def _on_finished(self, reply):
+        url = unicode(reply.url().toString())
+        status = str(reply.attribute(QNetworkRequest.HttpStatusCodeAttribute)
+                     .toString())
+        self.statuses[url] = int(status) if status else None
+
+    def _on_ssl_error(self, reply, errors):
+        if self.ignore_ssl_errors:
+            reply.ignoreSslErrors()
+        else:
+            raise PunkyError('SSL error(s) encountered. (Instantiate Browster'
+                             ' with ignore_ssl_errors=True to suppress'
+                             ' these).\n\nErrors:\n' +
+                '\n'.join(unicode(error.errorString()) for error in errors))
+
+    def _wait_load(self, timeout=None):
+        """Block until a web page is loaded.
+
+        If no page request was initiated, immediately return the load status
+        of the current page. Otherwise keep waiting until the requested page
+        finishes loading or the timeout period has elapsed. If the page does
+        not timeout, then return the load status.
+
+        """
+        self._events_loop(0.0)
+
+        if self._load_status is not None:
+            load_status = self._load_status
+            self._load_status = None
+            return load_status
+
+        # Keep waiting for the load to finish, until timeout occurs:
+        itime = time.time()
+        while self._load_status is None:
+            if timeout and time.time() - itime > timeout:
+                raise PunkyTimeout("Timeout reached: %d seconds" % timeout)
+            self._events_loop()
+
+        self._events_loop(0.0)
+
+        load_status = self._load_status
+        self._load_status = None
+        return load_status
+
+    @property
+    def doc(self):
+        """Return the QWebElement instance representing the current document."""
+        return self.webframe.documentElement()
+
+    @property
+    def html(self):
+        """Return a unicode string representing the HTML code of the current
+        frame.
+
+        """
+        return unicode(self.webframe.toHtml())
+
+    @property
+    def status(self):
+        """Return the HTTP status code received for the current location."""
+        try:
+            return self.statuses[self.url]
+        except KeyError:
+            pass
+
+    @property
+    def url(self):
+        """Return the URL of the current frame."""
+        return unicode(self.webframe.url().toString())
+
+    #{ Basic interaction with browser
+
+    def load(self, url, timeout=None):
+        """Initiate a page request and wait until the page either finishes
+        loading or times out.
+
+        Return the load status when done.
+
+        """
+        self.webframe.load(QUrl(url))
+        return self._wait_load(timeout)
+
+    def click(self, selector_or_element, wait_load=False, timeout=None):
+        """Click any clickable element on the current page. You can pass in
+        either a QWebElement instance, or string representing a CSS selector.
+        If you pass in CSS, the first matching element will be the one clicked."""
+
+        if isinstance(selector_or_element, QWebElement):
+            el = selector_or_element
+        else:
+            el = self._first(selector_or_element)
+
+        # Because we must create a new variable to initialize the mouse event
+        # object, we must do the work inside an anonymous function in order to
+        # not pollute global scope.
+        el.evaluateJavaScript("""
+        (function(el) {
+            var evt = document.createEvent('MouseEvents');
+            evt.initEvent('click', true, true);
+            el.dispatchEvent(evt);
+        })(this);
+        """)
+
+        if wait_load:
+            return self._wait_load(timeout)
+
+    def click_link(self, selector, timeout=None):
+        """Click a link and wait for the page to load."""
+        return self.click(selector, wait_load=True, timeout=timeout)
+
+    def wait_load(self, timeout=None):
+        """Wait until the page is loaded."""
+        return self._wait_load(timeout)
+
+    def wait(self, waittime):
+        """Wait some time.
+
+        This is an active wait, the events loop will be run, so it
+        may be useful to wait for synchronous Javascript events that
+        change the DOM.
+
+        """
+        itime = time.time()
+        while time.time() - itime < waittime:
+            self._events_loop()
+
+    def close(self):
+        """Close Browser instance and release resources."""
+        if self.webview:
+            self.destroy_webview()
+
+        if self.webpage:
+            del self.webpage
+
+    #{ Webview
+
+    def create_webview(self, show=False, focus=False):
+        """Create a QWebView object and insert current QWebPage into it."""
+        if self.webview:
+            raise PunkyError("Cannot create webview (already initialized)")
+
+        self.webview = QWebView()
+        self.webview.setPage(self.webpage)
+
+        window = self.webview.window()
+        window.setWindowTitle('PunkyBrowster')   # should this be configurable?
+        window.setAttribute(Qt.WA_DeleteOnClose)
+        window.connect(window, SIGNAL('destroyed(QObject *)'),
+                       self._on_webview_destroyed)
+
+        if not focus:
+            window.setAttribute(Qt.WA_ShowWithoutActivating)  # Stop stealing my window focus all the time.
+
+        if show:
+            self.show()
+
+    def destroy_webview(self):
+        """Destroy current QWebView."""
+        if not self.webview:
+            raise PunkyError("Cannot destroy webview (not initialized)")
+        del self.webview
+
+    def show(self):
+        """Show webview browser."""
+        if not self.webview:
+            raise PunkyError("Webview is not initialized")
+        self.webview.show()
+
+    def browse(self):
+        """Let the user browse the current page (infinite loop)."""
+        if not self.webview:
+            raise PunkyError("Webview is not initialized")
+
+        self.show()
+
+        while self.webview:
+            self._events_loop()
+
+    #}
+
+    #{ Form manipulation
+
+    def submit(self, selector, wait_load=False, timeout=None):
+        el = self._first(selector)
+
+        if el.tagName() == 'FORM':
+            el.evaluateJavaScript('this.submit()')
+        else:
+            raise PunkyError('Cannot call submit() on a non-form element')
+
+        if wait_load:
+            return self._wait_load(timeout)
+
+    def css(self, selector, css):
+        """Modify the CSS style of an element using a CSS selector."""
+        self._first(selector).setAttribute('style', css)
+
+    def fill(self, selector, value):
+        """Fill an input (of type text) or textarea with a string value using a
+        CSS selector.
+
+        NOTE: Using QWebElement.setAttribute() only works for text inputs. But
+        setting this.value through JS works for both text inputs AND text areas.
+
+        """
+        el = self._first(selector)
+
+        if el.tagName() == "TEXTAREA" or (el.tagName() == "INPUT" and
+                          el.attribute('type') in SUPPORTED_STRING_INPUT_TYPES):
+            # Make sure to handle double-quotes by escaping them
+            el.evaluateJavaScript(
+                u'this.value="{0}"'.format(value.replace('"', '\\"')))
+        else:
+            raise PunkyFormControlMismatch(
+                "Cannot 'fill()' on {0} element {1}".format(
+                    el.tagName(),
+                    dict((str(i), str(el.attribute(i)))
+                        for i in el.attributeNames())
+                    )
+                )
+
+
+    def check(self, selector):
+        """Check a checkbox."""
+        el = self._first(selector)
+
+        if el.tagName() == "INPUT" and el.attribute('type') in ('radio', 'checkbox'):
+            el.evaluateJavaScript('this.checked=true;')
+        else:
+            raise PunkyFormControlMismatch("Cannot 'check()' {0} element {1}".format(
+                    el.tagName(),
+                    dict((str(i), str(el.attribute(i)))
+                        for i in el.attributeNames())
+                    )
+                )
+
+    def uncheck(self, selector):
+        """Uncheck a checkbox."""
+        el = self._first(selector)
+
+        if el.tagName() == "INPUT" and el.attribute('type') == 'checkbox':
+            el.evaluateJavaScript('this.checked=false;')
+        else:
+            raise PunkyFormControlMismatch("Cannot 'uncheck()' {0} element {1}".format(
+                    el.tagName(),
+                    dict((str(i), str(el.attribute(i)))
+                        for i in el.attributeNames())
+                    )
+                )
+
+    choose = check          # choose a radio button
+
+    def select(self, selector):
+        """Mark a select widget's option selected."""
+        el = self._first(selector)
+
+        if el.tagName() == "OPTION":
+            # Make sure to mark the option as selected, but also manually
+            # trigger the 'change' event of the SELECT element
+            el.evaluateJavaScript("""
+                this.selected = true;
+                (function(selectEl) {
+                    var evt = document.createEvent('HTMLEvents');
+                    evt.initEvent('change', true, true);
+                    selectEl.dispatchEvent(evt);
+                })(this.parentNode);
+            """)
+        else:
+            raise PunkyFormControlMismatch("Cannot 'select()' {0} element {1}".format(
+                    el.tagName(),
+                    dict((str(i), str(el.attribute(i)))
+                        for i in el.attributeNames())
+                    )
+                )
+
+    #}
+
+    #{ Extract values
+
+    def value(self, selector):
+        """Return the value of the first element that matches the given
+        selector.
+
+        If no input[type=text] or textarea matches the selector, an
+        exception will be raised.
+
+        """
+        el = self._first(selector)
+        if el.tagName() == 'TEXTAREA' or \
+           (el.tagName() == 'INPUT' and str(el.attribute('type')) == 'text'):
+            v = self._first(selector).evaluateJavaScript('this.value')
+            return unicode(v.toString())
+        else:
+            raise PunkyError('value() expected input[type=text] or textarea')
+
+    def checked(self, selector):
+        """If the given selector references a checkbox or radio button, return
+        whether it is checked.
+
+        Otherwise raise an exception.
+
+        """
+        el = self._first(selector)
+        if el.tagName() == 'INPUT':
+            input_type = str(el.attribute('type'))
+            if input_type in ('radio', 'checkbox'):
+                v = self._first(selector).evaluateJavaScript('this.checked')
+                return v.toBool()
+
+        raise PunkyError('checked() expected input[type=radio] or input[type=checkbox]')
+
+    def selected(self, selector):
+        """If the given selector references an option element, return whether it
+        is selected.
+
+        Otherwise raise an exception.
+
+        """
+        el = self._first(selector)
+        if el.tagName() == 'OPTION':
+            v = self._first(selector).evaluateJavaScript('this.selected')
+            return v.toBool()
+
+        raise PunkyError('selected() expected option')
+
+    def text(self, selector):
+        """Return all text underneath the first element that matches the given
+        selector.
+
+        If no element matches the selector, an exception will be
+        raised.
+
+        """
+        return unicode(self._first(selector).toPlainText())
+
+    #}
+
+    #{ Javascript
+
+    def runjs(self, jscode):
+        """Evaluate some JavaScript on the current frame.
+
+        NOTE: Any variables created inside `jscode` will end up in the global
+        scope! (Unless you put them inside a function)
+
+        """
+        return self.webframe.evaluateJavaScript(jscode)
+
+    #}
+
+    #{ Miscellaneous
+
+    def save_snapshot(self, filename='snapshot.png', element=None):
+        """Take an image snapshot of the current frame. If a specific element is
+        specified, only grab the image of that one element.
+        """
+        format = QImage.Format_ARGB32
+
+        # First reset the viewport, then set it to the content size. If the
+        # viewport is not reset, the resulting image might be larger than
+        # necessary.
+        self.webpage.setViewportSize(QSize(1, 1))
+        self.webpage.setViewportSize(self.webframe.contentsSize())
+
+        if element is None:
+            image = QImage(self.webframe.contentsSize(), format)
+            painter = QPainter(image)
+            self.webframe.render(painter)
+            painter.end()
+        else:
+            # If element is actually a CSS selector:
+            if isinstance(element, basestring):
+                element = self._first(element)
+
+            rect = element.geometry()
+            w, h = rect.width(), rect.height()
+
+            x1 = rect.x()
+            y1 = rect.y()
+            x2 = x1 + w
+            y2 = y1 + h
+
+            image = QImage(QSize(x2, y2), format)
+            painter = QPainter(image)
+            self.webframe.render(painter)
+            painter.end()
+            image = image.copy(x1, y1, w, h)
+
+        image.save(filename)
+
+    #}
+
+
+class PunkyError(Exception):
+    """General Punky error."""
+
+
+class PunkyElementNotFound(PunkyError):
+    """No element found"""
+
+
+class PunkyFormControlMismatch(PunkyError):
+    """Attempted to call a form-manipulation method on a control that doesn't support it."""
+
+
+class PunkyTimeout(PunkyError):
+    """A timeout (usually on page load) has been reached."""
+"""Punky requires PyQt. How you obtain the PyQt binaries depends on your
+platform:
+
+- Mac: Build the binaries yourself (good luck), or find a package installer
+- Linux: Use a package manager, such as apt (apt-get install python-qt4)
+- Windows: Use the binary installer from Riverbank
+  (http://www.riverbankcomputing.co.uk/software/pyqt/download)
+
+"""
+import re
+
+from setuptools import setup
+
+
+# Get __version__, (w/wout spaces, single/doublequoted, w/wout hotfix number).
+init = file('./punky/__init__.py').read()
+version = re.search(r"__version__ ?= ?(?:'|\")(\d+\.\d+(?:\.\d+)?)(?:'|\")",
+                    init)
+assert version
+
+
+setup(
+    name="PunkyBrowster",
+    version=version.group(1),
+    description="Programmatic web browsing module",
+    author="Leapfrog Direct Response LLC",
+    url="http://bitbucket.org/leapfrogdevelopment/punkybrowster/",
+    packages=[
+        "punky",
+    ],
+    tests_require=[
+        "nose>=0.11.4",
+        "PIL>=1.1.6",
+    ],
+    test_suite='t.test',
+    scripts=[],
+    license="GNU Public License v3.0",
+    long_description="""\
+PunkyBrowster is a programmatic browser with a synchronous API. It is a fork of
+the spynner project. We remove unessential stuff like URL filtering, download
+handling, and cookie emulation. We also remove some potentially harmful stuff
+like JavaScript injection. What's left is a fairly lean core of functionality,
+and on top of that we add some extra support for DOM queries and mouse click
+emulation.""",
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License (GPL)',
+        'Natural Language :: English',
+        'Operating System :: POSIX',
+        'Operating System :: Microsoft :: Windows',
+        'Programming Language :: Python',
+        'Topic :: Internet :: WWW/HTTP',
+    ],
+)
+#!/usr/bin/env python
+import nose.core
+
+
+def main(argv=None):
+    nose.core.main(argv=argv)
+
+
+def test():
+    main(['', '-vs', 'tests'])
+
+if __name__ == '__main__':
+    main()

tests/__init__.py

+from nose.tools import eq_, set_trace as st
+
+from punky import Browster
+
+# All tests in this module will use this browser object:
+browser = Browster()
+#browser.create_webview(show=True)
+
+
+def teardown():
+    browser.close()

tests/pages/large_page.html

+<html>
+  <head>
+    <title>Large Page</title>
+    <style>
+    body {
+      background: orange;
+      width: 1000px;
+      height: 2000px;
+    }
+    </style>
+  </head>
+  <body>
+    This is a large page.
+  </body>
+</html>

tests/pages/small_page.html

+<html>
+  <head>
+    <title>Small Page</title>
+    <style>
+    body {
+      background: yellow;
+      width: 100px;
+      height: 200px;
+    }
+    </style>
+  </head>
+  <body>
+    This is a small page.
+  </body>
+</html>

tests/pages/test_dom_query.html

+<html>
+
+<head>
+    <title>test_dom_query</title>
+    
+    <style>
+    p { background-color: goldenrod; padding: 8px; margin-bottom: 30px; }
+    </style>
+
+    <script>
+    window.onload = function() {
+        for (var i=0; i < 20; i++) {
+            var el = document.createElement('p');
+            el.innerHTML = '(' + (i+1) + ') Hello Universe!';
+            document.body.appendChild(el);
+        }
+    }
+    </script>
+
+</head>
+
+<body>
+
+<h2 title="An apt description of this page">This page dynamically creates a lot of paragraph elements.</h2>
+
+</body>
+</html>

tests/pages/test_extract_values.html

+<html>
+
+<head>
+    <title>test_extract_values</title>
+    
+    <style>
+    p { padding: 8px; margin-bottom: 30px; }
+    </style>
+
+    <script>
+    window.onload = function() {
+        // Dynamically add some text:
+        var p = document.getElementById('boring-content');
+        var tn = document.createTextNode("The fox's head is blown off.");
+        p.appendChild(tn);
+    }
+    </script>
+
+</head>
+
+<body>
+
+<h2>Form values to be extracted</h2>
+
+<form>
+    <input type="text" value="antelope" />
+    <textarea>banana</textarea>
+    
+    <input type="checkbox" checked="yes" />
+    <input type="radio" />
+    
+    <select>
+        <option value="34">Capoeira</option>
+        <option value="36">Damascus</option>
+        <option value="38" selected="true">Elektra</option>
+        <option value="45">Frankenstein</option>
+    </select>    
+</form>
+
+
+<h2>Text to be extraced</h2>
+
+<p id="boring-content">
+    
+The <strong>quick</strong> brown fox <font size="5">jumps over</font> <br /> the
+<span style="color:green">lazy <span style="font-weight: bold; color: blue">dog</span></span>.
+
+<!-- Dynamically add some text -->
+<script type="text/javascript">
+document.write('<font size="-1">The lazy dog shoots the fox.</font>');
+</script>
+</p>
+
+</body>
+</html>

tests/pages/test_interaction.html

+<html>
+
+<head>
+    <title>test_interaction</title>
+    
+    <script>
+    var makeNewDiv = function(cls, text) {
+        var div = document.createElement('div');
+        
+        div.setAttribute('class', cls);
+        div.innerHTML = text;
+        
+        document.body.appendChild(div);
+    };
+    
+    var setSelectMessage = function() {
+        var span = document.getElementById('select_message');
+        span.innerHTML = 'Something was selected.'        
+    };
+    </script>
+
+</head>
+
+<body>
+
+<button id="make-new-div" onclick="makeNewDiv('button-click', 'Button was clicked')">Click this button baby</button>
+
+<br />
+
+<a id="normal-link" href="test_interaction_2.html">Click this link to go to another page</a>
+
+<br />
+
+<form action="test_interaction_2.html">
+    <input name="text_input" id="text_input" type="text" value="foobar" />
+    
+    <br />
+    
+    <input name="unchecked_checkbox" id="unchecked_checkbox" type="checkbox" />Unchecked checkbox
+    
+    <br />
+    
+    <input name="checked_checkbox" id="checked_checkbox"  type="checkbox" checked="checked" />Checked checkbox
+    
+    <br />
+    
+    <select name="select" id="select" onchange="setSelectMessage();">
+        <option value="77">Salsa</option>
+        <option value="88">Rumba</option>
+        <option value="99">Tango</option>
+    </select>
+    <span id="select_message"></span>
+    
+    <br />
+
+    <input name="mood" type="radio" value="angry" />Angry
+    <input name="mood" type="radio" value="livid" checked="checked" />Livid
+    <input name="mood" type="radio" value="hulk" />Hulk Smash!
+    
+    <br />
+    
+    <input type="submit" value="Submit" />
+</form>
+
+</body>
+</html>

tests/pages/test_interaction_2.html

+<html>
+
+<head>
+    <title>test_interaction_2</title>
+</head>
+
+<body>
+
+<p>This is another page entirely.</p>
+
+</body>
+</html>

tests/pages/test_load.html

+<html>
+
+<head>
+    <title>test_interaction</title>
+    <script type="text/javascript" src="notjs.js" />
+</head>
+
+<body>
+
+<p>This is a page.</p>
+
+</body>
+</html>

tests/pages/test_load_2.html

+<html>
+
+<head>
+    <title>test_interaction_2</title>
+    <script type="text/javascript" src="notjs.js" />
+</head>
+
+<body>
+
+<p>This is another page entirely.</p>
+
+</body>
+</html>

tests/pages/test_snapshot.html

+<html>
+
+<head>
+    <title>test_snapshot</title>
+    
+    <style>
+    body {
+        background-color: aliceblue;
+        padding: 0;
+        margin: 20px;
+        /*
+            If the height and width were not explicitly set here, then they
+            could potentially be much larger when saving a snapshot.
+        */
+        width: 280px;
+        height: 400px;        
+    }
+    
+    #content {        
+        border: 1px dotted black;
+        color: red;
+    }
+    
+    #side-bar {
+        float: right;
+        width: 100px;
+        height: 200px;
+        border: 1px dashed black;
+        padding: 10px;
+        margin: 0 0 10px 25px;
+    }
+    </style>
+
+</head>
+
+<body>
+
+<div id="side-bar">
+The Bene Gesserit's "Litany Against Fear"
+</div>
+
+<div id="content">
+I must not fear.
+Fear is the mind-killer.
+Fear is the little-death that brings total obliteration.
+I will face my fear.
+I will permit it to pass over me and through me.
+And when it has gone past I will turn the inner eye to see its path.
+Where the fear has gone there will be nothing.
+Only I will remain. 
+</div>
+
+</body>
+</html>

tests/test_basics.py

+from nose import tools
+
+from tests import browser
+
+
+def test_statuses():
+    # TODO: Until we add a test server, this can't test that the
+    # TODO: status code is stored right.
+
+    def try_status(file_):
+        url = "tests/pages/%s" % file_
+        browser.load(url)
+        urls = sorted(browser.statuses.iterkeys())
+        tools.eq_(len(urls), 2)
+        assert urls[0].endswith('notjs.js')
+        assert urls[1].endswith(url)
+        tools.eq_(browser.statuses.values(), [None, None])
+
+    for file_ in ("test_load.html", "test_load_2.html"):
+        yield try_status, file_

tests/test_dom_query.py

+from nose.tools import eq_, set_trace as st
+from PyQt4.QtWebKit import QWebElement
+
+from tests import browser
+
+
+def test_all():
+    """Does the all() method return a list of QWebElement objects?
+
+    NOTE: Even if they are dynamically created by JavaScript?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+
+    paras = browser.all('p')
+    assert isinstance(paras, list)
+    assert isinstance(paras[0], QWebElement)
+    eq_(len(paras), 20)
+
+
+def test_all_return_empty_list():
+    """Does the all() method return an empty list when no elements are found?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+
+    imgs = browser.all('img')       # there are no images on this page
+    assert isinstance(imgs, list)
+    eq_(len(imgs), 0)
+
+
+def test_first():
+    """Does the first() method return a QWebElement object?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+
+    # Look for an H2 element whose title attribute contains the word "description"
+    h2 = browser.first('h2[title*="description"]')
+
+    # Did we get the right element?
+    eq_(unicode(h2.toPlainText()), 'This page dynamically creates a lot of paragraph elements.')
+
+    assert isinstance(h2, QWebElement)
+
+
+def test_first_return_none():
+    """Does the first() method return None if no element is found?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+
+    h1 = browser.first('h1[title$="wacky"]')  # there are no h1 elements on this page
+    eq_(h1, None)
+
+
+def test_count():
+    """Does the count() method return the right value?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+    eq_(browser.count('p'), 20)
+    eq_(browser.count('h2[title]'), 1)
+
+
+def test_count_return_zero():
+    """Does count() return 0 when no elements are found?
+    """
+    browser.load('tests/pages/test_dom_query.html')
+    eq_(browser.count('h1'), 0)

tests/test_extract_values.py

+import re
+
+from nose.tools import eq_, set_trace as st
+
+from tests import browser
+from punky.browster import PunkyError
+
+
+def test_value_checked_selected():
+    """Do the value(), checked() and selected() methods return the expected
+    values?
+    """
+    browser.load('tests/pages/test_extract_values.html')
+
+    eq_(browser.value('form input[type=text]'), 'antelope')
+    eq_(browser.value('form textarea'), 'banana')
+
+    eq_(browser.checked('form input[type=checkbox]'), True)
+    eq_(browser.checked('form input[type=radio]'), False)
+
+    eq_(browser.selected('form option:first-child'), False)
+    eq_(browser.selected('form option:nth-child(3)'), True)
+
+
+def test_value_checked_selected_with_exceptions():
+    """Do the value(), checked() and selected() methods raise the expected
+    exceptions when they receive bad selectors?
+    """
+    browser.load('tests/pages/test_extract_values.html')
+
+    try:
+        browser.value('form input[type=checkbox]')
+        assert False, 'unreachable line'
+    except PunkyError, e:
+        eq_(str(e), 'value() expected input[type=text] or textarea')
+
+    try:
+        browser.checked('form textarea')
+        assert False, 'unreachable line'
+    except PunkyError, e:
+        eq_(str(e), 'checked() expected input[type=radio] or input[type=checkbox]')
+
+    try:
+        browser.selected('form select')
+        assert False, 'unreachable line'
+    except PunkyError, e:
+        eq_(str(e), 'selected() expected option')
+
+
+def test_text():
+    """Does the text() method return the expected value?
+
+    NOTE: Even if the text is dynamically added to the document?
+
+    """
+    browser.load('tests/pages/test_extract_values.html')
+    text = browser.text('#boring-content')
+    # FIXME: Whitespace can be handled slightly erratically, for reasons I
+    # FIXME: cannot determine.
+    text = re.sub(r'\s+', ' ', text)
+    eq_(text, "The quick brown fox jumps over the lazy dog. The lazy dog "
+              "shoots the fox. The fox's head is blown off.")

tests/test_interaction.py

+from nose.tools import eq_, set_trace as st
+from PyQt4.QtWebKit import QWebElement
+
+from tests import browser
+
+
+def test_click_with_selector():
+    """Does calling click() on a button element, specified with a CSS selector,
+    cause that button's onclick handler to execute?
+    """
+    browser.load('tests/pages/test_interaction.html')
+
+    browser.click('button#make-new-div')
+
+    # Give the JavaScript a little time to execute. This test will probably fail
+    # unless wait() is invoked.
+    browser.wait(0.05)
+
+    # Did clicking the button actually create a new DIV element?
+    div = browser.first('div.button-click')
+    assert div is not None
+
+def test_click_with_element():
+    """Can you invoke click() directly on a QWebElement?"""
+
+    browser.load('tests/pages/test_interaction.html')
+
+    elem = browser.first('button#make-new-div')
+
+    browser.click(elem)
+    browser.wait(0.05)
+
+    # Did clicking the button actually create a new DIV element?
+    div = browser.first('div.button-click')
+    assert div is not None
+
+def test_click_link():
+    """Does calling click_link() on an anchor element cause the browser to load another page?
+    """
+    browser.load('tests/pages/test_interaction.html')
+
+    browser.click_link('a#normal-link')
+
+    p = browser.first('p')
+    eq_(p.toPlainText(), 'This is another page entirely.')
+
+
+def test_css():
+    """Does calling css() on an element change its style?
+    """
+    browser.load('tests/pages/test_interaction.html')
+
+    browser.css('#normal-link', """
+    background-color: pink;
+    border: 3px dashed purple;
+    padding: 10px;
+    margin: 60px 10px;
+    font-size: 1.5em;
+    """)
+
+    el = browser.first('#normal-link')
+    values = [str(el.evaluateJavaScript('this.style.%s' % name).toString())
+              for name in
+              ('backgroundColor', 'border', 'padding', 'margin', 'fontSize')]
+
+    eq_(values, ['rgb(255, 192, 203)', '3px dashed purple', '10px', '60px 10px', '1.5em'])
+
+
+def test_fill():
+    """Does calling fill() on an input element cause that element to receive a new value?
+    """
+    browser.load('tests/pages/test_interaction.html')
+
+    browser.fill('#text_input', 'vuvuzelas ruined the world cup')
+
+    # Let us grab the value of that element using raw JavaScript
+    qvariant = browser.runjs("document.getElementById('text_input').value")
+    value = unicode(qvariant.toString())
+    eq_(value, "vuvuzelas ruined the world cup")
+
+
+def test_fill_unicode():
+    """Does passing a unicode string to fill() still work?
+    """
+    browser.load('tests/pages/test_interaction.html')
+