Initial version

.gitignore

+*~
+*.swp
+*.pyc
+bin
+eggs
+parts
+.installed.cfg
+.mr.developer.cfg
+*.egg-info
+src
+develop-eggs

LICENSE.txt

+                    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>.

bootstrap.py

+##############################################################################
+#
+# Copyright (c) 2006 Zope Foundation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bootstrap a buildout-based project
+
+Simply run this script in a directory containing a buildout.cfg.
+The script accepts buildout command-line options, so you can
+use the -c option to specify an alternate configuration file.
+"""
+
+import os, shutil, sys, tempfile, urllib, urllib2, subprocess
+from optparse import OptionParser
+
+if sys.platform == 'win32':
+    def quote(c):
+        if ' ' in c:
+            return '"%s"' % c  # work around spawn lamosity on windows
+        else:
+            return c
+else:
+    quote = str
+
+# See zc.buildout.easy_install._has_broken_dash_S for motivation and comments.
+stdout, stderr = subprocess.Popen(
+    [sys.executable, '-Sc',
+     'try:\n'
+     '    import ConfigParser\n'
+     'except ImportError:\n'
+     '    print 1\n'
+     'else:\n'
+     '    print 0\n'],
+    stdout=subprocess.PIPE, stderr=subprocess.PIPE).communicate()
+has_broken_dash_S = bool(int(stdout.strip()))
+
+# In order to be more robust in the face of system Pythons, we want to
+# run without site-packages loaded.  This is somewhat tricky, in
+# particular because Python 2.6's distutils imports site, so starting
+# with the -S flag is not sufficient.  However, we'll start with that:
+if not has_broken_dash_S and 'site' in sys.modules:
+    # We will restart with python -S.
+    args = sys.argv[:]
+    args[0:0] = [sys.executable, '-S']
+    args = map(quote, args)
+    os.execv(sys.executable, args)
+# Now we are running with -S.  We'll get the clean sys.path, import site
+# because distutils will do it later, and then reset the path and clean
+# out any namespace packages from site-packages that might have been
+# loaded by .pth files.
+clean_path = sys.path[:]
+import site  # imported because of its side effects
+sys.path[:] = clean_path
+for k, v in sys.modules.items():
+    if k in ('setuptools', 'pkg_resources') or (
+        hasattr(v, '__path__') and
+        len(v.__path__) == 1 and
+        not os.path.exists(os.path.join(v.__path__[0], '__init__.py'))):
+        # This is a namespace package.  Remove it.
+        sys.modules.pop(k)
+
+is_jython = sys.platform.startswith('java')
+
+setuptools_source = 'http://peak.telecommunity.com/dist/ez_setup.py'
+distribute_source = 'http://python-distribute.org/distribute_setup.py'
+
+
+# parsing arguments
+def normalize_to_url(option, opt_str, value, parser):
+    if value:
+        if '://' not in value:  # It doesn't smell like a URL.
+            value = 'file://%s' % (
+                urllib.pathname2url(
+                    os.path.abspath(os.path.expanduser(value))),)
+        if opt_str == '--download-base' and not value.endswith('/'):
+            # Download base needs a trailing slash to make the world happy.
+            value += '/'
+    else:
+        value = None
+    name = opt_str[2:].replace('-', '_')
+    setattr(parser.values, name, value)
+
+usage = '''\
+[DESIRED PYTHON FOR BUILDOUT] bootstrap.py [options]
+
+Bootstraps a buildout-based project.
+
+Simply run this script in a directory containing a buildout.cfg, using the
+Python that you want bin/buildout to use.
+
+Note that by using --setup-source and --download-base to point to
+local resources, you can keep this script from going over the network.
+'''
+
+parser = OptionParser(usage=usage)
+parser.add_option("-v", "--version", dest="version",
+                          help="use a specific zc.buildout version")
+parser.add_option("-d", "--distribute",
+                   action="store_true", dest="use_distribute", default=False,
+                   help="Use Distribute rather than Setuptools.")
+parser.add_option("--setup-source", action="callback", dest="setup_source",
+                  callback=normalize_to_url, nargs=1, type="string",
+                  help=("Specify a URL or file location for the setup file. "
+                        "If you use Setuptools, this will default to " +
+                        setuptools_source + "; if you use Distribute, this "
+                        "will default to " + distribute_source + "."))
+parser.add_option("--download-base", action="callback", dest="download_base",
+                  callback=normalize_to_url, nargs=1, type="string",
+                  help=("Specify a URL or directory for downloading "
+                        "zc.buildout and either Setuptools or Distribute. "
+                        "Defaults to PyPI."))
+parser.add_option("--eggs",
+                  help=("Specify a directory for storing eggs.  Defaults to "
+                        "a temporary directory that is deleted when the "
+                        "bootstrap script completes."))
+parser.add_option("-t", "--accept-buildout-test-releases",
+                  dest='accept_buildout_test_releases',
+                  action="store_true", default=False,
+                  help=("Normally, if you do not specify a --version, the "
+                        "bootstrap script and buildout gets the newest "
+                        "*final* versions of zc.buildout and its recipes and "
+                        "extensions for you.  If you use this flag, "
+                        "bootstrap and buildout will get the newest releases "
+                        "even if they are alphas or betas."))
+parser.add_option("-c", None, action="store", dest="config_file",
+                   help=("Specify the path to the buildout configuration "
+                         "file to be used."))
+
+options, args = parser.parse_args()
+
+# if -c was provided, we push it back into args for buildout's main function
+if options.config_file is not None:
+    args += ['-c', options.config_file]
+
+if options.eggs:
+    eggs_dir = os.path.abspath(os.path.expanduser(options.eggs))
+else:
+    eggs_dir = tempfile.mkdtemp()
+
+if options.setup_source is None:
+    if options.use_distribute:
+        options.setup_source = distribute_source
+    else:
+        options.setup_source = setuptools_source
+
+if options.accept_buildout_test_releases:
+    args.append('buildout:accept-buildout-test-releases=true')
+args.append('bootstrap')
+
+try:
+    import pkg_resources
+    import setuptools  # A flag.  Sometimes pkg_resources is installed alone.
+    if not hasattr(pkg_resources, '_distribute'):
+        raise ImportError
+except ImportError:
+    ez_code = urllib2.urlopen(
+        options.setup_source).read().replace('\r\n', '\n')
+    ez = {}
+    exec ez_code in ez
+    setup_args = dict(to_dir=eggs_dir, download_delay=0)
+    if options.download_base:
+        setup_args['download_base'] = options.download_base
+    if options.use_distribute:
+        setup_args['no_fake'] = True
+    ez['use_setuptools'](**setup_args)
+    if 'pkg_resources' in sys.modules:
+        reload(sys.modules['pkg_resources'])
+    import pkg_resources
+    # This does not (always?) update the default working set.  We will
+    # do it.
+    for path in sys.path:
+        if path not in pkg_resources.working_set.entries:
+            pkg_resources.working_set.add_entry(path)
+
+cmd = [quote(sys.executable),
+       '-c',
+       quote('from setuptools.command.easy_install import main; main()'),
+       '-mqNxd',
+       quote(eggs_dir)]
+
+if not has_broken_dash_S:
+    cmd.insert(1, '-S')
+
+find_links = options.download_base
+if not find_links:
+    find_links = os.environ.get('bootstrap-testing-find-links')
+if find_links:
+    cmd.extend(['-f', quote(find_links)])
+
+if options.use_distribute:
+    setup_requirement = 'distribute'
+else:
+    setup_requirement = 'setuptools'
+ws = pkg_resources.working_set
+setup_requirement_path = ws.find(
+    pkg_resources.Requirement.parse(setup_requirement)).location
+env = dict(
+    os.environ,
+    PYTHONPATH=setup_requirement_path)
+
+requirement = 'zc.buildout'
+version = options.version
+if version is None and not options.accept_buildout_test_releases:
+    # Figure out the most recent final version of zc.buildout.
+    import setuptools.package_index
+    _final_parts = '*final-', '*final'
+
+    def _final_version(parsed_version):
+        for part in parsed_version:
+            if (part[:1] == '*') and (part not in _final_parts):
+                return False
+        return True
+    index = setuptools.package_index.PackageIndex(
+        search_path=[setup_requirement_path])
+    if find_links:
+        index.add_find_links((find_links,))
+    req = pkg_resources.Requirement.parse(requirement)
+    if index.obtain(req) is not None:
+        best = []
+        bestv = None
+        for dist in index[req.project_name]:
+            distv = dist.parsed_version
+            if _final_version(distv):
+                if bestv is None or distv > bestv:
+                    best = [dist]
+                    bestv = distv
+                elif distv == bestv:
+                    best.append(dist)
+        if best:
+            best.sort()
+            version = best[-1].version
+if version:
+    requirement = '=='.join((requirement, version))
+cmd.append(requirement)
+
+if is_jython:
+    import subprocess
+    exitcode = subprocess.Popen(cmd, env=env).wait()
+else:  # Windows prefers this, apparently; otherwise we would prefer subprocess
+    exitcode = os.spawnle(*([os.P_WAIT, sys.executable] + cmd + [env]))
+if exitcode != 0:
+    sys.stdout.flush()
+    sys.stderr.flush()
+    print ("An error occurred when trying to install zc.buildout. "
+           "Look above this message for any errors that "
+           "were output by easy_install.")
+    sys.exit(exitcode)
+
+ws.add_entry(eggs_dir)
+ws.require(requirement)
+import zc.buildout.buildout
+zc.buildout.buildout.main(args)
+if not options.eggs:  # clean up temporary egg directory
+    shutil.rmtree(eggs_dir)

buildout.cfg

+; vim: set fileencoding=utf-8 :
+; Andre Anjos <andre.anjos@idiap.ch>
+; Mon 16 Apr 08:29:18 2012 CEST
+
+[buildout]
+parts = python
+develop = .
+eggs = bob.db.replay
+
+[python]
+recipe = zc.recipe.egg
+interpreter = python
+eggs = ${buildout:eggs}

localbob.cfg

+; vim: set fileencoding=utf-8 :
+; Andre Anjos <andre.anjos@idiap.ch>
+; Mon 16 Apr 08:29:18 2012 CEST
+
+; Example buildout recipe using a local (off-root) Bob installation
+
+[buildout]
+parts = bob python tests
+develop = .
+eggs = bob
+       bob.db.replay
+
+[bob]
+recipe = local.bob.recipe:config
+
+; Set here the private installation directory for Bob
+install-directory = /scratch/aanjos/bob-master/build/newdb/release
+
+[python]
+recipe = zc.recipe.egg
+interpreter = python
+eggs = ${buildout:eggs}
+
+[tests]
+recipe = pbp.recipe.noserunner
+eggs = ${buildout:eggs}
+       pbp.recipe.noserunner
+script = tests.py

readme.rst

+========================
+ Replay Attack Database
+========================
+
+This package contains the access API and descriptions for the `Replay Attack
+Database <http://www.idiap.ch/dataset/replayattack/>`_. The actual raw data for
+the database should be downloaded from the given URL, this package contains
+only the `Bob <http://idiap.ch/software/bob/>`_ accessor methods to use the DB
+directly from python, with our certified protocols.
+
+You would normally not install this package unless you are maintaining it. What
+you would do instead is to tie it in at the package you need to **use** it.
+There are a few ways to achieve this:
+
+  1. You can add this package as a requirement at the ``setup.py`` for your own
+     `satellite package
+     <https://github.com/idiap/bob/wiki/Virtual-Work-Environments-with-Buildout>`_
+     or to your Buildout ``.cfg`` file, if you prefer it that way. With this
+     method, this package gets automatically downloaded and installed on your
+     working environment, or
+
+  2. You can manually download and install this package using commands like
+     ``easy_install`` or ``pip``.
+
+The package is available in two different distribution formats:
+
+  a. You can download it from `PyPI <http://pypi.python.org/pypi>`_, or
+
+  b. You can download it in its source form from `its git repository
+  <http://github.com/bioidiap/bob.db.replay.git>`_. When you download the
+  version at the git repository, you will need to run a command to recreate the
+  backend SQLite file required for its operation. This means that the database
+  raw files must be installed somewhere in this case. With option ``a`` you can
+  run in `dummy` mode and only download the raw data files for the database
+  once you are happy with your setup.
+
+You can mix and match points 1/2 and a/b above based on your requirements. Here
+are some examples:
+
+Modify your setup.py and download from PyPI
+===========================================
+
+That is the easiest. Edit your ``setup.py`` in your satellite package and add
+the following entry in the ``install_requires`` section (note: ``...`` means
+`whatever extra stuff you may have in-between`, don't put that on your
+script)::
+
+    install_requires=[
+      ...
+      "bob.db.replay >= 1.1",
+    ],
+
+Proceed normally with your ``boostrap/buildout`` steps and you should be all
+set. That means you can now import ``bob.db.replay`` into your scripts.
+
+Modify your buildout.cfg and download from git
+==============================================
+
+You will need to add a dependence to `mr.developer
+<http://pypi.python.org/pypi/mr.developer/>`_ to be able to install from our
+git repositories. Your ``buildout.cfg`` file should contain the following
+lines::
+
+  [buildout]
+  ...
+  extensions = mr.developer
+  auto-checkout = *
+  eggs = bob
+         ...
+         bob.db.replay
+
+  [sources]
+  bob.db.replay = git https://github.com/bioidiap/bob.db.replay.git
+  ...

replay/db/__init__.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.dos.anjos@gmail.com>
+# Wed 18 May 09:28:44 2011 
+
+"""The Idiap Replay attack database consists of Photo and Video attacks to
+different identities under different illumination conditions.
+"""
+
+import os
+
+def dbname():
+  '''Returns the database name'''
+  
+  return 'replay'
+
+def version():
+  '''Returns the current version number defined in setup.py (DRY)'''
+
+  import pkg_resources  # part of setuptools
+  return pkg_resources.require('bob.db.replay')[0].version
+
+def location():
+  '''Returns the directory that contains the data'''
+
+  return os.path.dirname(os.path.realpath(__file__))
+
+def files():
+  '''Returns a python iterable with all auxiliary files needed'''
+
+  return ('db.sql3',)
+
+def type():
+  '''Returns the type of auxiliary files you have for this database
+  
+  If you return 'sqlite', then we append special actions such as 'dbshell'
+  on 'bob_dbmanage.py' automatically for you. Otherwise, we don't. 
+
+  If you use auxiliary text files, just return 'text'. We may provide
+  special services for those types in the future.
+  '''
+
+  return 'sqlite'
+
+# these are required for the dbmanage.py driver
+from .query import Database
+from .commands import add_commands

replay/db/checkfiles.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.anjos@idiap.ch>
+# Tue 20 Mar 19:20:22 2012 CET
+
+"""Checks for installed files.
+"""
+
+import os
+import sys
+
+# Driver API
+# ==========
+
+def checkfiles(args):
+  """Checks existence files based on your criteria"""
+
+  from .query import Database
+  db = Database()
+
+  r = db.files(
+      directory=args.directory,
+      extension=args.extension,
+      protocol=args.protocol, 
+      support=args.support, 
+      groups=args.group,
+      cls=args.cls,
+      light=args.light,
+      )
+
+  # go through all files, check if they are available on the filesystem
+  good = {}
+  bad = {}
+  for id, f in r.items():
+    if os.path.exists(f): good[id] = f
+    else: bad[id] = f
+
+  # report
+  output = sys.stdout
+  if args.selftest:
+    from bob.db.utils import null
+    output = null()
+
+  if bad:
+    for id, f in bad.items():
+      output.write('Cannot find file "%s"\n' % (f,))
+    output.write('%d files (out of %d) were not found at "%s"\n' % \
+        (len(bad), len(r), args.directory))
+
+  return 0
+
+def add_command(subparsers):
+  """Add specific subcommands that the action "checkfiles" can use"""
+
+  from argparse import SUPPRESS
+
+  parser = subparsers.add_parser('checkfiles', help=checkfiles.__doc__)
+
+  from .query import Database
+
+  db = Database()
+
+  if not db.is_valid():
+    protocols = ('waiting','for','database','creation')
+  else:
+    protocols = db.protocols()
+
+  parser.add_argument('-d', '--directory', dest="directory", default='', help="if given, this path will be prepended to every entry checked (defaults to '%(default)s')")
+  parser.add_argument('-e', '--extension', dest="extension", default='', help="if given, this extension will be appended to every entry checked (defaults to '%(default)s')")
+  parser.add_argument('-c', '--class', dest="cls", default='', help="if given, limits the check to a particular subset of the data that corresponds to the given class (defaults to '%(default)s')", choices=('real', 'attack', 'enroll'))
+  parser.add_argument('-g', '--group', dest="group", default='', help="if given, this value will limit the check to those files belonging to a particular protocolar group. (defaults to '%(default)s')", choices=db.groups())
+  parser.add_argument('-s', '--support', dest="support", default='', help="if given, this value will limit the check to those files using this type of attack support. (defaults to '%(default)s')", choices=db.attack_supports())
+  parser.add_argument('-x', '--protocol', dest="protocol", default='', help="if given, this value will limit the check to those files for a given protocol. (defaults to '%(default)s')", choices=protocols)
+  parser.add_argument('-l', '--light', dest="light", default='', help="if given, this value will limit the check to those files shot under a given lighting. (defaults to '%(default)s')", choices=db.lights())
+  parser.add_argument('--self-test', dest="selftest", default=False,
+      action='store_true', help=SUPPRESS)
+
+  parser.set_defaults(func=checkfiles) #action

replay/db/commands.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.anjos@idiap.ch>
+# Tue 28 Jun 2011 15:20:09 CEST 
+
+"""Commands this database can respond to.
+"""
+
+import os
+import sys
+
+def reverse(args):
+  """Returns a list of file database identifiers given the path stems"""
+
+  from .query import Database
+  db = Database()
+
+  output = sys.stdout
+  if args.selftest:
+    from bob.db.utils import null
+    output = null()
+
+  r = db.reverse(args.path)
+  for id in r: output.write('%d\n' % id)
+  
+  if not r: return 1
+
+  return 0
+
+def reverse_command(subparsers):
+  """Adds the specific options for the reverse command"""
+
+  from argparse import SUPPRESS
+
+  parser = subparsers.add_parser('reverse', help=reverse.__doc__)
+
+  parser.add_argument('path', nargs='+', type=str, help="one or more path stems to look up. If you provide more than one, files which cannot be reversed will be omitted from the output.")
+  parser.add_argument('--self-test', dest="selftest", default=False,
+      action='store_true', help=SUPPRESS)
+
+  parser.set_defaults(func=reverse) #action
+
+def path(args):
+  """Returns a list of fully formed paths or stems given some file id"""
+
+  from .query import Database
+  db = Database()
+
+  output = sys.stdout
+  if args.selftest:
+    from bob.db.utils import null
+    output = null()
+
+  r = db.paths(args.id, prefix=args.directory, suffix=args.extension)
+  for path in r: output.write('%s\n' % path)
+
+  if not r: return 1
+
+  return 0
+
+def path_command(subparsers):
+  """Adds the specific options for the path command"""
+
+  from argparse import SUPPRESS
+
+  parser = subparsers.add_parser('path', help=path.__doc__)
+
+  parser.add_argument('-d', '--directory', dest="directory", default='', help="if given, this path will be prepended to every entry returned (defaults to '%(default)s')")
+  parser.add_argument('-e', '--extension', dest="extension", default='', help="if given, this extension will be appended to every entry returned (defaults to '%(default)s')")
+  parser.add_argument('id', nargs='+', type=int, help="one or more file ids to look up. If you provide more than one, files which cannot be found will be omitted from the output. If you provide a single id to lookup, an error message will be printed if the id does not exist in the database. The exit status will be non-zero in such case.")
+  parser.add_argument('--self-test', dest="selftest", default=False,
+      action='store_true', help=SUPPRESS)
+
+  parser.set_defaults(func=path) #action
+
+def add_commands(parser):
+  """Adds my subset of options and arguments to the top-level parser. For
+  details on syntax, please consult:
+
+  http://docs.python.org/dev/library/argparse.html
+
+  The strategy assumed here is that each command will have its own set of
+  options that are relevant to that command. So, we just scan such commands and
+  attach the options from those.
+  """
+
+  from . import dbname, location, version, type, files
+  from bob.db.utils import standard_commands
+  from . import __doc__ as dbdoc
+  from argparse import RawDescriptionHelpFormatter
+
+  # creates a top-level parser for this database
+  myname = dbname()
+  top_level = parser.add_parser(myname,
+      formatter_class=RawDescriptionHelpFormatter,
+      help="Photo/Video Replay attack database", description=dbdoc)
+  top_level.set_defaults(dbname=myname)
+  top_level.set_defaults(location=location())
+  top_level.set_defaults(version=version())
+  top_level.set_defaults(type=type())
+  top_level.set_defaults(files=files())
+
+  # declare it has subparsers for each of the supported commands
+  subparsers = top_level.add_subparsers(title="subcommands")
+
+  # attach standard commands
+  standard_commands(subparsers, type(), files())
+
+  # get the "create" action from a submodule
+  from .create import add_command as create_command
+  create_command(subparsers)
+
+  # get the "dumplist" action from a submodule
+  from .dumplist import add_command as dumplist_command
+  dumplist_command(subparsers)
+
+  # get the "checkfiles" action from a submodule
+  from .checkfiles import add_command as checkfiles_command
+  checkfiles_command(subparsers)
+
+  # adds the "reverse" command
+  reverse_command(subparsers)
+
+  # adds the "path" command
+  path_command(subparsers)

replay/db/create.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.dos.anjos@gmail.com>
+# Thu 12 May 08:19:50 2011 
+
+"""This script creates the Replay-Attack database in a single pass.
+"""
+
+import os
+import fnmatch
+
+from .models import *
+
+def add_clients(session, protodir, verbose):
+  """Add clients to the replay attack database."""
+  
+  for client in open(os.path.join(protodir, 'clients.txt'), 'rt'):
+    s = client.strip().split(' ', 2)
+    if not s: continue #empty line
+    id = int(s[0])
+    set = s[1]
+    if verbose: print "Adding client %d on '%s' set..." % (id, set)
+    session.add(Client(id, set))
+
+def add_real_lists(session, protodir, verbose):
+  """Adds all RCD filelists"""
+
+  def add_real_list(session, filename):
+    """Adds an RCD filelist and materializes RealAccess'es."""
+
+    def parse_real_filename(f):
+      """Parses the RCD filename and break it in the relevant chunks."""
+
+      v = os.path.splitext(os.path.basename(f))[0].split('_')
+      client_id = int(v[0].replace('client',''))
+      path = os.path.splitext(f)[0] #keep only the filename stem
+      purpose = v[3]
+      light = v[4]
+      if len(v) == 6: take = int(v[5]) #authentication session
+      else: take = 1 #enrollment session
+      return [client_id, path, light], [purpose, take]
+
+    for fname in open(filename, 'rt'):
+      s = fname.strip()
+      if not s: continue #emtpy line
+      filefields, realfields = parse_real_filename(s)
+      filefields[0] = session.query(Client).filter(Client.id == filefields[0]).one()
+      file = File(*filefields)
+      session.add(file)
+      realfields.insert(0, file)
+      session.add(RealAccess(*realfields))
+
+  add_real_list(session, os.path.join(protodir, 'real-train.txt'))
+  add_real_list(session, os.path.join(protodir, 'real-devel.txt'))
+  add_real_list(session, os.path.join(protodir, 'real-test.txt'))
+  add_real_list(session, os.path.join(protodir, 'recognition-train.txt'))
+  add_real_list(session, os.path.join(protodir, 'recognition-devel.txt'))
+  add_real_list(session, os.path.join(protodir, 'recognition-test.txt'))
+
+def add_attack_lists(session, protodir, verbose):
+  """Adds all RAD filelists"""
+
+  def add_attack_list(session, filename):
+    """Adds an RAD filelist and materializes Attacks."""
+
+    def parse_attack_filename(f):
+      """Parses the RAD filename and break it in the relevant chunks."""
+
+      v = os.path.splitext(os.path.basename(f))[0].split('_')
+      attack_device = v[1] #print, mobile or highdef
+      client_id = int(v[2].replace('client',''))
+      path = os.path.splitext(f)[0] #keep only the filename stem
+      sample_device = v[4] #highdef or mobile
+      sample_type = v[5] #photo or video
+      light = v[6]
+      attack_support = f.split('/')[-2]
+      return [client_id, path, light], [attack_support, attack_device, sample_type, sample_device]
+
+    for fname in open(filename, 'rt'):
+      s = fname.strip()
+      if not s: continue #emtpy line
+      filefields, attackfields = parse_attack_filename(s)
+      filefields[0] = session.query(Client).filter(Client.id == filefields[0]).one()
+      file = File(*filefields)
+      session.add(file)
+      attackfields.insert(0, file)
+      session.add(Attack(*attackfields))
+
+  add_attack_list(session,os.path.join(protodir, 'attack-grandtest-allsupports-train.txt'))
+  add_attack_list(session,os.path.join(protodir, 'attack-grandtest-allsupports-devel.txt'))
+  add_attack_list(session,os.path.join(protodir, 'attack-grandtest-allsupports-test.txt'))
+
+def define_protocols(session, protodir, verbose):
+  """Defines all available protocols"""
+
+  #figures out which protocols to use
+  valid = {}
+
+  for fname in fnmatch.filter(os.listdir(protodir), 'attack-*-allsupports-train.txt'):
+    s = fname.split('-', 4)
+
+    consider = True
+    files = {}
+
+    for grp in ('train', 'devel', 'test'):
+
+      # check attack file
+      attack = os.path.join(protodir, 'attack-%s-allsupports-%s.txt' % (s[1], grp))
+      if not os.path.exists(attack):
+        if verbose:
+          print "Not considering protocol %s as attack list '%s' was not found" % (s[1], attack)
+        consider = False
+      
+      # check real file
+      real = os.path.join(protodir, 'real-%s-allsupports-%s.txt' % (s[1], grp))
+      if not os.path.exists(real):
+        alt_real = os.path.join(protodir, 'real-%s.txt' % (grp,))
+        if not os.path.exists(alt_real):
+          if verbose:
+            print "Not considering protocol %s as real list '%s' or '%s' were not found" % (s[1], real, alt_real)
+          consider = False 
+        else:
+          real = alt_real
+
+      if consider: files[grp] = (attack, real)
+
+    if consider: valid[s[1]] = files
+
+  for protocol, groups in valid.iteritems():
+    if verbose: print "Creating protocol '%s'..." % protocol
+
+    # create protocol on the protocol table
+    obj = Protocol(name=protocol)
+
+    for grp, flist in groups.iteritems():
+
+      counter = 0
+      for fname in open(flist[0], 'rt'):
+        s = os.path.splitext(fname.strip())[0]
+        q = session.query(Attack).join(File).filter(File.path == s).one()
+        q.protocols.append(obj)
+        counter += 1
+      if verbose: print "  -> %5s/%-6s: %d files" % (grp, "attack", counter)
+   
+      counter = 0
+      for fname in open(flist[1], 'rt'):
+        s = os.path.splitext(fname.strip())[0]
+        q = session.query(RealAccess).join(File).filter(File.path == s).one()
+        q.protocols.append(obj)
+        counter += 1
+      if verbose: print "  -> %5s/%-6s: %d files" % (grp, "real", counter)
+      
+    session.add(obj)
+
+def create_tables(args):
+  """Creates all necessary tables (only to be used at the first time)"""
+
+  from bob.db.utils import connection_string
+
+  from sqlalchemy import create_engine
+  engine = create_engine(connection_string(args.type, args.location,
+    args.files[0]), echo=args.verbose)
+  Client.metadata.create_all(engine)
+  RealAccess.metadata.create_all(engine)
+  Attack.metadata.create_all(engine)
+  Protocol.metadata.create_all(engine)
+
+# Driver API
+# ==========
+
+def create(args):
+  """Creates or re-creates this database"""
+
+  from bob.db.utils import session
+
+  dbfile = os.path.join(args.location, args.files[0])
+
+  args.verbose = 0 if args.verbose is None else sum(args.verbose)
+
+  if args.recreate: 
+    if args.verbose and os.path.exists(dbfile):
+      print('unlinking %s...' % dbfile)
+    if os.path.exists(dbfile): os.unlink(dbfile)
+
+  if not os.path.exists(os.path.dirname(dbfile)):
+    os.makedirs(os.path.dirname(dbfile))
+
+  # the real work...
+  create_tables(args)
+  s = session(args.type, args.location, args.files[0], echo=(args.verbose >= 2))
+  add_clients(s, args.protodir, args.verbose)
+  add_real_lists(s, args.protodir, args.verbose)
+  add_attack_lists(s, args.protodir, args.verbose)
+  define_protocols(s, args.protodir, args.verbose)
+  s.commit()
+  s.close()
+
+  return 0
+  
+def add_command(subparsers):
+  """Add specific subcommands that the action "create" can use"""
+
+  parser = subparsers.add_parser('create', help=create.__doc__)
+
+  parser.add_argument('-R', '--recreate', action='store_true', default=False,
+      help="If set, I'll first erase the current database")
+  parser.add_argument('-v', '--verbose', action='append_const', const=1, 
+      help="Do SQL operations in a verbose way")
+  parser.add_argument('-D', '--protodir', action='store', 
+      default='/idiap/group/replay/database/protocols/replayattack-database/protocols',
+      metavar='DIR',
+      help="Change the relative path to the directory containing the protocol definitions for replay attacks (defaults to %(default)s)")
+  
+  parser.set_defaults(func=create) #action

replay/db/dumplist.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.dos.anjos@gmail.com>
+# Thu 12 May 14:02:28 2011 
+
+"""Dumps lists of files.
+"""
+
+import os
+import sys
+
+# Driver API
+# ==========
+
+def dumplist(args):
+  """Dumps lists of files based on your criteria"""
+
+  from .query import Database
+  db = Database()
+
+  r = db.files(
+      directory=args.directory, 
+      extension=args.extension,
+      protocol=args.protocol, 
+      support=args.support, 
+      groups=args.group, 
+      cls=args.cls,
+      light=args.light,
+      )
+
+  output = sys.stdout
+  if args.selftest:
+    from bob.db.utils import null
+    output = null()
+
+  for id, f in r.items():
+    output.write('%s\n' % (f,))
+
+  return 0
+
+def add_command(subparsers):
+  """Add specific subcommands that the action "dumplist" can use"""
+
+  from argparse import SUPPRESS
+
+  parser = subparsers.add_parser('dumplist', help=dumplist.__doc__)
+
+  from .query import Database
+
+  db = Database()
+
+  if not db.is_valid():
+    protocols = ('waiting','for','database','creation')
+  else:
+    protocols = db.protocols()
+
+  parser.add_argument('-d', '--directory', dest="directory", default='', help="if given, this path will be prepended to every entry returned (defaults to '%(default)s')")
+  parser.add_argument('-e', '--extension', dest="extension", default='', help="if given, this extension will be appended to every entry returned (defaults to '%(default)s')")
+  parser.add_argument('-c', '--class', dest="cls", default='', help="if given, limits the dump to a particular subset of the data that corresponds to the given class (defaults to '%(default)s')", choices=('real', 'attack', 'enroll'))
+  parser.add_argument('-g', '--group', dest="group", default='', help="if given, this value will limit the output files to those belonging to a particular protocolar group. (defaults to '%(default)s')", choices=db.groups())
+  parser.add_argument('-s', '--support', dest="support", default='', help="if given, this value will limit the output files to those using this type of attack support. (defaults to '%(default)s')", choices=db.attack_supports())
+  parser.add_argument('-x', '--protocol', dest="protocol", default='', help="if given, this value will limit the output files to those for a given protocol. (defaults to '%(default)s')", choices=protocols)
+  parser.add_argument('-l', '--light', dest="light", default='', help="if given, this value will limit the output files to those shot under a given lighting. (defaults to '%(default)s')", choices=db.lights())
+  parser.add_argument('--self-test', dest="selftest", default=False,
+      action='store_true', help=SUPPRESS)
+
+  parser.set_defaults(func=dumplist) #action

replay/db/models.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.dos.anjos@gmail.com>
+# Wed 11 May 18:52:38 2011
+
+"""Table models and functionality for the Replay Attack DB.
+"""
+
+from sqlalchemy import Table, Column, Integer, String, ForeignKey
+from bob.db.sqlalchemy_migration import Enum, relationship
+from sqlalchemy.orm import backref
+from sqlalchemy.ext.declarative import declarative_base
+
+Base = declarative_base()
+
+class Client(Base):
+  __tablename__ = 'client'
+
+  set_choices = ('train', 'devel', 'test')
+  
+  id = Column(Integer, primary_key=True)
+  set = Column(Enum(*set_choices))
+
+  def __init__(self, id, set):
+    self.id = id
+    self.set = set
+
+  def __repr__(self):
+    return "<Client('%s', '%s')>" % (self.id, self.set)
+
+class File(Base):
+  __tablename__ = 'file'
+
+  light_choices = ('controlled', 'adverse')
+
+  id = Column(Integer, primary_key=True)
+  client_id = Column(Integer, ForeignKey('client.id')) # for SQL
+  path = Column(String(100), unique=True)
+  light = Column(Enum(*light_choices))
+
+  # for Python
+  client = relationship(Client, backref=backref('files', order_by=id))
+
+  def __init__(self, client, path, light):
+    self.client = client
+    self.path = path
+    self.light = light
+
+  def __repr__(self):
+    print "<File('%s')>" % self.path
+
+# Intermediate mapping from RealAccess's to Protocol's
+realaccesses_protocols = Table('realaccesses_protocols', Base.metadata,
+    Column('realaccess_id', Integer, ForeignKey('realaccess.id')),
+    Column('protocol_id', Integer, ForeignKey('protocol.id')),
+    )
+
+# Intermediate mapping from Attack's to Protocol's
+attacks_protocols = Table('attacks_protocols', Base.metadata,
+    Column('attack_id', Integer, ForeignKey('attack.id')),
+    Column('protocol_id', Integer, ForeignKey('protocol.id')),
+    )
+
+class Protocol(Base):
+  __tablename__ = 'protocol'
+
+  id = Column(Integer, primary_key=True)
+  name = Column(String(20), unique=True)
+
+  def __init__(self, name):
+    self.name = name
+
+  def __repr__(self):
+    return "<Protocol('%s')>" % (self.name,)
+
+class RealAccess(Base):
+  __tablename__ = 'realaccess'
+
+  purpose_choices = ('authenticate', 'enroll')
+
+  id = Column(Integer, primary_key=True)
+  file_id = Column(Integer, ForeignKey('file.id')) # for SQL
+  purpose = Column(Enum(*purpose_choices))
+  take = Column(Integer)
+
+  # for Python
+  file = relationship(File, backref=backref('realaccess', order_by=id))
+  protocols = relationship("Protocol", secondary=realaccesses_protocols,
+      backref='realaccesses')
+
+  def __init__(self, file, purpose, take):
+    self.file = file
+    self.purpose = purpose
+    self.take = take
+
+  def __repr__(self):
+    return "<RealAccess('%s')>" % (self.file.path)
+
+class Attack(Base):
+  __tablename__ = 'attack'
+
+  attack_support_choices = ('fixed', 'hand')
+  attack_device_choices = ('print', 'mobile', 'highdef', 'mask')
+  sample_type_choices = ('video', 'photo')
+  sample_device_choices = ('mobile', 'highdef')
+
+  id = Column(Integer, primary_key=True)
+  file_id = Column(Integer, ForeignKey('file.id')) # for SQL
+  attack_support = Column(Enum(*attack_support_choices))
+  attack_device = Column(Enum(*attack_device_choices))
+  sample_type = Column(Enum(*sample_type_choices))
+  sample_device = Column(Enum(*sample_device_choices))
+
+  # for Python
+  file = relationship(File, backref=backref('attack', order_by=id))
+  protocols = relationship("Protocol", secondary=attacks_protocols,
+      backref='attacks')
+
+  def __init__(self, file, attack_support, attack_device, sample_type, sample_device):
+    self.file = file
+    self.attack_support = attack_support
+    self.attack_device = attack_device
+    self.sample_type = sample_type
+    self.sample_device = sample_device
+
+  def __repr__(self):
+    return "<Attack('%s')>" % (self.file.path)

replay/db/query.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.dos.anjos@gmail.com>
+# Tue 17 May 13:58:09 2011 
+
+"""This module provides the Dataset interface allowing the user to query the
+replay attack database in the most obvious ways.
+"""
+
+import os
+import logging
+from bob.db import utils
+from .models import *
+from . import dbname, type, location, files
+
+SQLITE_FILE = os.path.join(location(), files()[0])
+
+class Database(object):
+  """The dataset class opens and maintains a connection opened to the Database.
+
+  It provides many different ways to probe for the characteristics of the data
+  and for the data itself inside the database.
+  """
+
+  def __init__(self):
+    # opens a session to the database - keep it open until the end
+    self.connect()
+  
+  def connect(self):
+    """Tries connecting or re-connecting to the database"""
+    if not os.path.exists(SQLITE_FILE):
+      self.session = None
+
+    else:
+      self.session = utils.session(type(), location(), files()[0])
+
+  def is_valid(self):
+    """Returns if a valid session has been opened for reading the database"""
+
+    return self.session is not None
+
+  def files(self, directory=None, extension=None,
+      support=Attack.attack_support_choices,
+      protocol='grandtest', 
+      groups=Client.set_choices, 
+      cls=('attack', 'real'), 
+      light=File.light_choices):
+    """Returns a set of filenames for the specific query by the user.
+
+    Keyword Parameters:
+
+    directory
+      A directory name that will be prepended to the final filepath returned
+
+    extension
+      A filename extension that will be appended to the final filepath returned
+
+    support
+      One of the valid support types as returned by attack_supports() or all,
+      as a tuple.  If you set this parameter to an empty string or the value
+      None, we use reset it to the default, which is to get all.
+
+    protocol
+      The protocol for the attack. One of the ones returned by protocols(). If
+      you set this parameter to an empty string or the value None, we use reset
+      it to the default, "grandtest".
+
+    groups
+      One of the protocolar subgroups of data as returned by groups() or a
+      tuple with several of them.  If you set this parameter to an empty string
+      or the value None, we use reset it to the default which is to get all.
+
+    cls
+      Either "attack", "real", "enroll" or any combination of those (in a
+      tuple). Defines the class of data to be retrieved.  If you set this
+      parameter to an empty string or the value None, we use reset it to the
+      default, ("real", "attack").
+
+    light
+      One of the lighting conditions as returned by lights() or a combination
+      of the two (in a tuple), which is also the default.
+
+    Returns: A dictionary containing the resolved filenames considering all
+    the filtering criteria. The keys of the dictionary are unique identities 
+    for each file in the replay attack database. Conserve these numbers if you 
+    wish to save processing results later on.
+    """
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    def check_validity(l, obj, valid, default):
+      """Checks validity of user input data against a set of valid values"""
+      if not l: return default
+      elif isinstance(l, str): return check_validity((l,), obj, valid, default)
+      for k in l:
+        if k not in valid:
+          raise RuntimeError, 'Invalid %s "%s". Valid values are %s, or lists/tuples of those' % (obj, k, valid)
+      return l
+
+    def make_path(stem, directory, extension):
+      if not extension: extension = ''
+      if directory: return os.path.join(directory, stem + extension)
+      return stem + extension
+
+    # check if groups set are valid
+    VALID_GROUPS = self.groups()
+    groups = check_validity(groups, "group", VALID_GROUPS, VALID_GROUPS)
+
+    # check if supports set are valid
+    VALID_SUPPORTS = self.attack_supports()
+    support = check_validity(support, "support", VALID_SUPPORTS, VALID_SUPPORTS)
+
+    # by default, do NOT grab enrollment data from the database
+    VALID_CLASSES = ('real', 'attack', 'enroll')
+    cls = check_validity(cls, "class", VALID_CLASSES, ('real', 'attack'))
+
+    # check protocol validity
+    if not protocol: protocol = 'grandtest' #default
+    VALID_PROTOCOLS = self.protocols()
+    if protocol not in VALID_PROTOCOLS:
+      raise RuntimeError, 'Invalid protocol "%s". Valid values are %s' % \
+          (protocol, VALID_PROTOCOLS)
+
+    # resolve protocol object
+    protocol = self.protocol(protocol)
+
+    # checks if the light is valid
+    VALID_LIGHTS = self.lights()
+    light = check_validity(light, "light", VALID_LIGHTS, VALID_LIGHTS)
+
+    # now query the database
+    retval = {}
+
+    # real-accesses are simpler to query
+    if 'enroll' in cls:
+      q = self.session.query(RealAccess).join(File).join(Client).filter(Client.set.in_(groups)).filter(RealAccess.purpose=='enroll').filter(File.light.in_(light)).order_by(Client.id)
+      for key, value in [(k.file.id, k.file.path) for k in q]: 
+        retval[key] = make_path(str(value), directory, extension)
+      
+    # real-accesses are simpler to query
+    if 'real' in cls:
+      q = self.session.query(RealAccess).join(File).join(Client).filter(RealAccess.protocols.contains(protocol)).filter(Client.set.in_(groups)).filter(File.light.in_(light)).order_by(Client.id)
+      for key, value in [(k.file.id, k.file.path) for k in q]:
+        retval[key] = make_path(str(value), directory, extension)
+
+    # attacks will have to be filtered a little bit more
+    if 'attack' in cls:
+      q = self.session.query(Attack).join(File).join(Client).filter(Attack.protocols.contains(protocol)).filter(Client.set.in_(groups)).filter(Attack.attack_support.in_(support)).filter(File.light.in_(light)).order_by(Client.id)
+
+      for key, value in [(k.file.id, k.file.path) for k in q]: 
+        retval[key] = make_path(str(value), directory, extension)
+
+    return retval
+
+  def protocols(self):
+    """Returns the names of all registered protocols"""
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    return tuple([k.name for k in self.session.query(Protocol)])
+
+  def has_protocol(self, name):
+    """Tells if a certain protocol is available"""
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    return self.session.query(Protocol).filter(Protocol.name==name).count() != 0
+
+  def protocol(self, name):
+    """Returns the protocol object in the database given a certain name. Raises
+    an error if that does not exist."""
+    
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    return self.session.query(Protocol).filter(Protocol.name==name).one()
+
+  def groups(self):
+    """Returns the names of all registered groups"""
+    return Client.set_choices
+
+  def lights(self):
+    """Returns light variations available in the database"""
+    return File.light_choices
+
+  def attack_supports(self):
+    """Returns attack supports available in the database"""
+    return Attack.attack_support_choices
+
+  def attack_devices(self):
+    """Returns attack devices available in the database"""
+    return Attack.attack_device_choices
+
+  def attack_sampling_devices(self):
+    """Returns sampling devices available in the database"""
+    return Attack.sample_device_choices
+
+  def attack_sample_types(self):
+    """Returns attack sample types available in the database"""
+    return Attack.sample_type_choices
+
+  def paths(self, ids, prefix='', suffix=''):
+    """Returns a full file paths considering particular file ids, a given
+    directory and an extension
+    
+    Keyword Parameters:
+
+    id
+      The ids of the object in the database table "file". This object should be
+      a python iterable (such as a tuple or list).
+
+    prefix
+      The bit of path to be prepended to the filename stem
+
+    suffix
+      The extension determines the suffix that will be appended to the filename
+      stem.
+
+    Returns a list (that may be empty) of the fully constructed paths given the
+    file ids.
+    """
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    fobj = self.session.query(File).filter(File.id.in_(ids))
+    retval = []
+    for p in ids:
+      retval.extend([os.path.join(prefix, str(k.path) + suffix) 
+        for k in fobj if k.id == p])
+    return retval
+
+  def reverse(self, paths):
+    """Reverses the lookup: from certain stems, returning file ids
+    
+    Keyword Parameters:
+
+    paths
+      The filename stems I'll query for. This object should be a python
+      iterable (such as a tuple or list)
+
+    Returns a list (that may be empty).
+    """
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    fobj = self.session.query(File).filter(File.path.in_(paths))
+    retval = []
+    for p in paths:
+      retval.extend([k.id for k in fobj if k.path == p])
+    return retval
+
+  def save_one(self, id, obj, directory, extension):
+    """Saves a single object supporting the bob save() protocol.
+
+    This method will call save() on the the given object using the correct
+    database filename stem for the given id.
+    
+    Keyword Parameters:
+
+    id
+      The id of the object in the database table "file".
+
+    obj
+      The object that needs to be saved, respecting the bob save() protocol.
+
+    directory
+      This is the base directory to which you want to save the data. The
+      directory is tested for existence and created if it is not there with
+      os.makedirs()
+
+    extension
+      The extension determines the way each of the arrays will be saved.
+    """
+
+    if not self.is_valid():
+      raise RuntimeError, "Database '%s' cannot be found at expected location '%s'. Create it and then try re-connecting using Database.connect()" % (dbname(), SQLITE_FILE)
+
+    from bob.io import save
+
+    fobj = self.session.query(File).filter_by(id=id).one()
+    fullpath = os.path.join(directory, str(fobj.path) + extension)
+    fulldir = os.path.dirname(fullpath)
+    utils.makedirs_safe(fulldir)
+    save(obj, fullpath)
+
+  def save(self, data, directory, extension):
+    """This method takes a dictionary of blitz arrays or bob.database.Array's
+    and saves the data respecting the original arrangement as returned by
+    files().
+
+    Keyword Parameters:
+
+    data
+      A dictionary with two keys 'real' and 'attack', each containing a
+      dictionary mapping file ids from the original database to an object that
+      supports the bob "save()" protocol.
+
+    directory
+      This is the base directory to which you want to save the data. The
+      directory is tested for existence and created if it is not there with
+      os.makedirs()
+
+    extension
+      The extension determines the way each of the arrays will be saved.
+    """
+    
+    for key, value in data:
+      self.save_one(key, value, directory, extension)

replay/test.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.anjos@idiap.ch>
+# Mon Aug 8 12:40:24 2011 +0200
+#
+# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland
+# 
+# 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, version 3 of the License.
+# 
+# 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/>.
+
+"""A few checks at the replay attack database.
+"""
+
+import os, sys
+import unittest
+from . import db as replay_db
+
+class ReplayDatabaseTest(unittest.TestCase):
+  """Performs various tests on the replay attack database."""
+
+  def test01_queryRealAccesses(self):
+
+
+    db = replay_db.Database()
+    f = db.files(cls='real')
+    self.assertEqual(len(set(f.values())), 200) #200 unique auth sessions
+    for k,v in f.items():
+      self.assertTrue( (v.find('authenticate') != -1) )
+      self.assertTrue( (v.find('real') != -1) )
+      self.assertTrue( (v.find('webcam') != -1) )
+    
+    train = db.files(cls='real', groups='train')
+    self.assertEqual(len(set(train.values())), 60)
+
+    dev = db.files(cls='real', groups='devel')
+    self.assertEqual(len(set(dev.values())), 60)
+
+    test = db.files(cls='real', groups='test')
+    self.assertEqual(len(set(test.values())), 80)
+
+    #tests train, devel and test files are distinct
+    s = set(train.values() + dev.values() + test.values())
+    self.assertEqual(len(s), 200)
+
+  def queryAttackType(self, protocol, N):
+
+    db = replay_db.Database()
+    f = db.files(cls='attack', protocol=protocol)
+
+    self.assertEqual(len(set(f.values())), N) 
+    for k,v in f.items():
+      self.assertTrue(v.find('attack') != -1)
+
+    train = db.files(cls='attack', groups='train', protocol=protocol)
+    self.assertEqual(len(set(train.values())), int(round(0.3*N)))
+
+    dev = db.files(cls='attack', groups='devel', protocol=protocol)
+    self.assertEqual(len(set(dev.values())), int(round(0.3*N)))
+
+    test = db.files(cls='attack', groups='test', protocol=protocol)
+    self.assertEqual(len(set(test.values())), int(round(0.4*N)))
+
+    #tests train, devel and test files are distinct
+    s = set(train.values() + dev.values() + test.values())
+    self.assertEqual(len(s), N)
+
+  def test02_queryAttacks(self):
+
+    self.queryAttackType('grandtest', 1000)
+  
+  def test03_queryPrintAttacks(self):
+
+    self.queryAttackType('print', 200)
+  
+  def test04_queryMobileAttacks(self):
+
+    self.queryAttackType('mobile', 400)
+  
+  def test05_queryHighDefAttacks(self):
+
+    self.queryAttackType('highdef', 400)
+  
+  def test06_queryPhotoAttacks(self):
+
+    self.queryAttackType('photo', 600)
+  
+  def test07_queryVideoAttacks(self):
+
+    self.queryAttackType('video', 400)
+  
+  def test08_queryEnrollments(self):
+
+    db = replay_db.Database()
+    f = db.files(cls='enroll')
+    self.assertEqual(len(set(f.values())), 100) #50 clients, 2 conditions
+    for k,v in f.items():
+      self.assertTrue(v.find('enroll') != -1)
+
+  def test09_manage_get(self):
+
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay get --dry-run'.split()), 0)
+    self.assertEqual(main('replay get --version=bla --dry-run'.split()), 0)
+    self.assertEqual(main('replay get --version=1.3.4 --verbose --dry-run'.split()), 0)
+
+  def test10_manage_put(self):
+
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay put --dry-run tmp'.split()), 0)
+    self.assertEqual(main('replay put --version=bla --dry-run tmp'.split()), 0)
+    self.assertEqual(main('replay put --version=1.3.4 --verbose --dry-run tmp'.split()), 0)
+
+  def test11_manage_location(self):
+
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay location'.split()), 0)
+
+  def test12_manage_dumplist_1(self):
+
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay dumplist --self-test'.split()), 0)
+
+  def test13_manage_dumplist_2(self):
+    
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay dumplist --class=attack --group=devel --support=hand --protocol=highdef --self-test'.split()), 0)
+
+  def test14_manage_checkfiles(self):
+
+    from bob.db.script.dbmanage import main
+
+    self.assertEqual(main('replay checkfiles --self-test'.split()), 0)

setup.py

+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+# Andre Anjos <andre.anjos@idiap.ch>
+# Sex 10 Ago 2012 14:22:33 CEST
+
+from setuptools import setup, find_packages
+
+# The only thing we do in this file is to call the setup() function with all
+# parameters that define our package.
+setup(
+
+    name='bob.db.replay',
+    version='master',
+    description='Replay Attack Database Access API for Bob',
+    url='http://github.com/bioidiap/bob.db.replay',
+    license='LICENSE.txt',
+    author_email='Andre Anjos <andre.anjos@idiap.ch>',
+    #long_description=open('doc/howto.rst').read(),
+
+    # This line is required for any distutils based packaging.
+    packages=find_packages(),
+
+    # Always include your .sql3 file with the package data. This will make sure
+    # it is packaged correctly for PyPI uploads or for any other package
+    # management system such as Ubuntu's.
+    package_data = {
+      'replay': [
+        'db/db.sql3',
+        ],
+      },
+
+    install_requires=[
+        "bob == master",  # base signal proc./machine learning library
+    ],
+
+    entry_points={
+      'console_scripts': [
+        # for tests or db creation, enable the following line:
+        #'driver.py = bob.db.script.dbmanage:main',
+        ],
+      'bob.db': [
+        'replay = replay.db',
+        ]
+      },
+
+)