--- /dev/null
+*.pyc
+recipe
+mom*
--- /dev/null
+ 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>.
--- /dev/null
+Cookbook provides a Python interface to your recipes so you can throw
+out all those index cards.
+
+The entry script:
+ ./bin/cook.py
+fires up the server, binding it to a local interface/port. It also
+translates cookbook formats, e.g. from my mom's rough text file to the
+more robust directory of YAML files that Cookbook uses internally.
+
+The recipes themselves will generally be stored in per-recipe YAML
+files under 'recipe'.
+
+Send any bug reports to W. Trevor King <wking@drexel.edu>.
--- /dev/null
+#!/usr/bin/python
+
+# Copyright
+
+import os.path
+
+import cookbook
+from cookbook import Cookbook
+from cookbook.mom import MomParser
+from cookbook.cookbook import test as test_cookbook
+
+try:
+ import cherrypy
+ from cookbook.server import Server
+ from cookbook.server import test as test_server
+except ImportError, e:
+ cherrypy = e
+ def test_server():
+ pass
+
+
+if __name__ == '__main__':
+ import optparse
+ import sys
+
+ # HACK! to ensure we *always* get utf-8 output
+ p = optparse.OptionParser()
+ p.add_option('-t', '--test', dest='test', default=False,
+ action='store_true', help='run internal tests and exit')
+ p.add_option('-m', '--mom', dest='mom', metavar='PATH',
+ help="load Mom's cookbook")
+ p.add_option('-s', '--serve', dest='serve', default=False,
+ action='store_true', help='serve cookbook')
+ p.add_option('-a', '--address', dest='address', default='127.0.0.1',
+ metavar='ADDR', help='address that the server will bind to')
+ p.add_option('-p', '--port', dest='port', default='8080',
+ metavar='PORT', help='port that the server will listen on')
+
+ options,arguments = p.parse_args()
+
+ if options.test == True:
+ test_cookbook()
+ test_server()
+ sys.exit(0)
+
+ if isinstance(cherrypy, ImportError):
+ raise cherrypy
+
+ sys.stderr.write('Loading cookbook\n')
+ if options.mom == None:
+ c = Cookbook()
+ c.load()
+ else:
+ p = MomParser()
+ c = p.parse(options.mom)
+
+ if options.serve == False:
+ sys.stderr.write('Saving cookbook\n')
+ c.save('new-recipe')
+ else:
+ #reload(sys)
+ #sys.setdefaultencoding('utf-8')
+ sys.stderr.write('Serving cookbook\n')
+ module_dir = os.path.dirname(os.path.abspath(cookbook.__file__))
+ static_dir = os.path.join(module_dir, 'static')
+ template_dir = os.path.join(module_dir, 'template')
+ config = os.path.join(module_dir, 'config')
+ s = Server(c, template_dir)
+ cherrypy.config.update({ # http://www.cherrypy.org/wiki/ConfigAPI
+ 'server.socket_host': options.address,
+ 'server.socket_port': int(options.port),
+ 'tools.encode.on': True,
+ 'tools.encode.encoding': 'utf8',
+ 'tools.staticdir.root': static_dir
+ })
+ app_config = { '/static': { 'tools.staticdir.on': True,
+ 'tools.staticdir.dir': '', } }
+ cherrypy.quickstart(root=s, config=app_config)
+ sys.stderr.write('Saving cookbook\n')
+ s.cleanup()
--- /dev/null
+"""Cookbook package, for manipulating and serving cookbooks.
+
+Submodules:
+* cookbook, basic cookbook classes
+* server, for serving a cookbook over HTTP
+* mom, for parsing my mom's cookbook format
+"""
+
+from .cookbook import Cookbook
+
+__all__ = {'Cookbook':Cookbook}
--- /dev/null
+#!/usr/bin/python
+# -*- encoding: utf-8 -*-
+#
+# Copyright
+
+"""Represent a cookbook and recipes with Python classes.
+"""
+
+import os
+import os.path
+import textwrap
+import types
+
+import yaml
+
+
+def string_for_yaml(unicode_):
+ """
+ >>> string_for_yaml(None)
+ >>> string_for_yaml('all ascii')
+ 'all ascii'
+ >>> string_for_yaml(u'all ascii')
+ 'all ascii'
+ >>> string_for_yaml(u'½ ascii')
+ u'\\xc2\\xbd ascii'
+ """
+ if unicode_ == None:
+ return unicode_
+ try:
+ string = unicode_.encode('ascii')
+ return string
+ except UnicodeEncodeError:
+ return unicode_
+
+def to_yaml_object(obj):
+ """
+ >>> to_yaml_object(None)
+ >>> to_yaml_object('all ascii')
+ 'all ascii'
+ >>> to_yaml_object(u'all ascii')
+ 'all ascii'
+ >>> to_yaml_object('all ascii')
+ 'all ascii'
+ >>> to_yaml_object(u'½ ascii')
+ u'\\xc2\\xbd ascii'
+ >>> class x (object):
+ ... def to_yaml(self):
+ ... return 'to_yaml return value'
+ >>> to_yaml_object(x())
+ 'to_yaml return value'
+ >>> to_yaml_object([u'all ascii', u'½ ascii'])
+ ['all ascii', u'\\xc2\\xbd ascii']
+ """
+ if obj == None:
+ return obj
+ if hasattr(obj, 'to_yaml'):
+ return obj.to_yaml()
+ if type(obj) in types.StringTypes:
+ return string_for_yaml(obj)
+ if hasattr(obj, '__len__'):
+ ret = []
+ for item in obj:
+ ret.append(to_yaml_object(item))
+ return ret
+ raise NotImplementedError(
+ 'cannot convert %s to YAMLable dict:\n%s' % (type(obj), unicode(obj)))
+
+
+class Amount (object):
+ """
+ >>> import pprint
+ >>> a = Amount(value='1', units='T.')
+ >>> str(a)
+ '1 T.'
+ >>> pprint.pprint(a.to_yaml())
+ {'alternatives': [], 'range_': None, 'units': 'T.', 'value': '1'}
+ >>> x = Amount()
+ >>> x.from_yaml(a.to_yaml())
+ >>> str(x)
+ '1 T.'
+ >>> b = Amount(value='1')
+ >>> str(b)
+ '1'
+ >>> pprint.pprint(b.to_yaml())
+ {'alternatives': [], 'range_': None, 'units': None, 'value': '1'}
+ >>> x.from_yaml(b.to_yaml())
+ >>> str(x)
+ '1'
+ >>> c = Amount(value='15', units='mL', alternatives=[a])
+ >>> str(c)
+ '15 mL (1 T.)'
+ >>> pprint.pprint(c.to_yaml())
+ {'alternatives': [{'alternatives': [],
+ 'range_': None,
+ 'units': 'T.',
+ 'value': '1'}],
+ 'range_': None,
+ 'units': 'mL',
+ 'value': '15'}
+ >>> x.from_yaml(c.to_yaml())
+ >>> str(x)
+ '15 mL (1 T.)'
+ >>> d = Amount(units='T.', range_=['1','2'])
+ >>> str(d)
+ '1-2 T.'
+ >>> pprint.pprint(d.to_yaml())
+ {'alternatives': [], 'range_': ['1', '2'], 'units': 'T.', 'value': None}
+ >>> x.from_yaml(d.to_yaml())
+ >>> str(x)
+ '1-2 T.'
+ """
+ def __init__(self, value=None, units=None, range_=None, alternatives=None):
+ self.value = value
+ self.units = units
+ self.range_ = range_
+ if alternatives == None:
+ alternatives = []
+ self.alternatives = alternatives
+
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ if self.range_ == None:
+ value = self.value
+ else:
+ value = '-'.join(self.range_)
+ ret = [value]
+ if self.units != None:
+ ret.append(self.units)
+ if len(self.alternatives) > 0:
+ ret.append('(%s)' % ', '.join(
+ [unicode(a) for a in self.alternatives]))
+ return ' '.join(ret)
+
+ def to_yaml(self):
+ d = {}
+ for key in ['value', 'range_', 'units', 'alternatives']:
+ d[key] = to_yaml_object(getattr(self, key))
+ return d
+
+ def from_yaml(self, dict):
+ for key in ['value', 'range_', 'units']:
+ setattr(self, key, dict.get(key, None))
+ self.alternatives = []
+ for a in dict.get('alternatives', []):
+ amount = Amount()
+ amount.from_yaml(a)
+ self.alternatives.append(amount)
+
+
+class Ingredient (object):
+ """
+ >>> import pprint
+ >>> i = Ingredient('eye of newt', Amount('1'))
+ >>> str(i)
+ '1 eye of newt'
+ >>> pprint.pprint(i.to_yaml())
+ {'amount': {'alternatives': [], 'range_': None, 'units': None, 'value': '1'},
+ 'name': 'eye of newt',
+ 'note': None}
+ >>> x = Ingredient()
+ >>> x.from_yaml(i.to_yaml())
+ >>> str(x)
+ '1 eye of newt'
+ >>> j = Ingredient('salamanders', Amount('2'), 'diced fine')
+ >>> str(j)
+ '2 salamanders, diced fine'
+ >>> pprint.pprint(j.to_yaml())
+ {'amount': {'alternatives': [], 'range_': None, 'units': None, 'value': '2'},
+ 'name': 'salamanders',
+ 'note': 'diced fine'}
+ >>> x.from_yaml(j.to_yaml())
+ >>> str(x)
+ '2 salamanders, diced fine'
+ """
+ def __init__(self, name=None, amount=None, note=None):
+ self.name = name
+ self.amount = amount
+ self.note = note
+
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ if self.note == None:
+ return '%s %s' % (unicode(self.amount), self.name)
+ return '%s %s, %s' % (unicode(self.amount), self.name, self.note)
+
+ def to_yaml(self):
+ d = {}
+ for key in ['name', 'amount', 'note']:
+ d[key] = to_yaml_object(getattr(self, key))
+ return d
+
+ def from_yaml(self, dict):
+ for key in ['name', 'note']:
+ setattr(self, key, dict.get(key, None))
+ self.amount = Amount()
+ self.amount.from_yaml(dict.get('amount', {}))
+
+
+class IngredientBlock (list):
+ """
+ >>> import pprint
+ >>> ib = IngredientBlock(None, [
+ ... Ingredient('eye of newt', Amount('1')),
+ ... Ingredient('salamanders', Amount('2'), 'diced fine')])
+ >>> print str(ib)
+ Ingredients:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ >>> pprint.pprint(ib.to_yaml())
+ {'ingredients': [{'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '1'},
+ 'name': 'eye of newt',
+ 'note': None},
+ {'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '2'},
+ 'name': 'salamanders',
+ 'note': 'diced fine'}],
+ 'name': None}
+ >>> x = IngredientBlock()
+ >>> x.from_yaml(ib.to_yaml())
+ >>> print str(x)
+ Ingredients:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ >>> ib.name = 'Dressing'
+ >>> print str(ib)
+ Dressing:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ >>> pprint.pprint(ib.to_yaml())
+ {'ingredients': [{'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '1'},
+ 'name': 'eye of newt',
+ 'note': None},
+ {'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '2'},
+ 'name': 'salamanders',
+ 'note': 'diced fine'}],
+ 'name': 'Dressing'}
+ >>> x = IngredientBlock()
+ >>> x.from_yaml(ib.to_yaml())
+ >>> print str(x)
+ Dressing:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ """
+ def __init__(self, name=None, *args, **kwargs):
+ self.name = name
+ super(IngredientBlock, self).__init__(*args, **kwargs)
+
+ def heading(self):
+ if self.name == None:
+ return 'Ingredients'
+ return self.name
+
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ ret = [unicode(i) for i in self]
+ ret.insert(0, '%s:' % self.heading())
+ return '\n '.join(ret)
+
+ def to_yaml(self):
+ d = {}
+ for key in ['name']:
+ d[key] = to_yaml_object(getattr(self, key))
+ d['ingredients'] = to_yaml_object(list(self))
+ return d
+
+ def from_yaml(self, dict):
+ self.name = dict.get('name', None)
+ while len(self) > 0:
+ self.pop()
+ for i in dict.get('ingredients', []):
+ ingredient = Ingredient()
+ ingredient.from_yaml(i)
+ self.append(ingredient)
+
+
+class Directions (list):
+ """
+ >>> import pprint
+ >>> d = Directions(['paragraph 1', 'paragraph 2', 'paragraph 3'])
+ >>> print str(d)
+ paragraph 1
+ <BLANKLINE>
+ paragraph 2
+ <BLANKLINE>
+ paragraph 3
+ >>> pprint.pprint(d.to_yaml())
+ 'paragraph 1\\n\\nparagraph 2\\n\\nparagraph 3'
+ >>> x = Directions()
+ >>> x.from_yaml(d.to_yaml())
+ >>> print str(x)
+ paragraph 1
+ <BLANKLINE>
+ paragraph 2
+ <BLANKLINE>
+ paragraph 3
+ >>> pprint.pprint(x.to_yaml())
+ 'paragraph 1\\n\\nparagraph 2\\n\\nparagraph 3'
+ """
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ return '\n\n'.join(self)
+
+ def wrapped_paragraphs(self, *args, **kwargs):
+ return ['\n'.join(
+ textwrap.wrap(
+ paragraph,
+ *args,
+ **kwargs))
+ for paragraph in self]
+
+ def wrap(self, *args, **kwargs):
+ return '\n\n'.join(self.wrapped_paragraphs(*args, **kwargs))
+
+ def to_yaml(self):
+ return string_for_yaml('\n\n'.join([paragraph.rstrip('\n')
+ for paragraph in self]))
+
+ def from_yaml(self, string):
+ while len(self) > 0:
+ self.pop()
+ for paragraph in string.split('\n\n'):
+ self.append(paragraph)
+
+
+class Recipe (object):
+ """
+ >>> import pprint
+ >>> r = Recipe('Hot Newt Dressing',
+ ... [IngredientBlock(None, [
+ ... Ingredient('eye of newt', Amount('1')),
+ ... Ingredient('salamanders', Amount('2'), 'diced fine')])],
+ ... Directions(['Mix ingredients until salamander starts to smoke',
+ ... 'Serve warm over rice']),
+ ... yield_='enough for one apprentice',
+ ... author='Merlin',
+ ... source='CENSORED',
+ ... url='http://merlin.uk/recipes/1234/',
+ ... tags=['dinner', 'easy', 'apprentice', 'eye', 'newt', 'salamander'])
+ >>> print str(r)
+ Recipe: Hot Newt Dressing
+ Yield: enough for one apprentice
+ From: Merlin
+ Source: CENSORED
+ URL: http://merlin.uk/recipes/1234/
+ Ingredients:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ Mix ingredients until salamander starts to smoke
+ <BLANKLINE>
+ Serve warm over rice
+ >>> pprint.pprint(r.to_yaml())
+ {'author': 'Merlin',
+ 'directions': 'Mix ingredients until salamander starts to smoke\\n\\nServe warm over rice',
+ 'ingredient_blocks': [{'ingredients': [{'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '1'},
+ 'name': 'eye of newt',
+ 'note': None},
+ {'amount': {'alternatives': [],
+ 'range_': None,
+ 'units': None,
+ 'value': '2'},
+ 'name': 'salamanders',
+ 'note': 'diced fine'}],
+ 'name': None}],
+ 'name': 'Hot Newt Dressing',
+ 'source': 'CENSORED',
+ 'tags': ['dinner', 'easy', 'apprentice', 'eye', 'newt', 'salamander'],
+ 'url': 'http://merlin.uk/recipes/1234/',
+ 'yield_': 'enough for one apprentice'}
+ >>> x = Recipe()
+ >>> x.from_yaml(r.to_yaml())
+ >>> print str(x)
+ Recipe: Hot Newt Dressing
+ Yield: enough for one apprentice
+ From: Merlin
+ Source: CENSORED
+ URL: http://merlin.uk/recipes/1234/
+ Ingredients:
+ 1 eye of newt
+ 2 salamanders, diced fine
+ Mix ingredients until salamander starts to smoke
+ <BLANKLINE>
+ Serve warm over rice
+ """
+ def __init__(self, name=None, ingredient_blocks=None, directions=None,
+ yield_=None, author=None, source=None, url=None, tags=None):
+ self.name = name
+ self.ingredient_blocks = ingredient_blocks
+ self.directions = directions
+ self.yield_ = yield_
+ self.author = author
+ self.source = source
+ self.url = url
+ self.tags = tags
+
+ def clean_name(self):
+ name = self.name
+ for from_,to in [(' ','_'), ('/', '_'),
+ (',', ''), (u'\xe2\x80\x99', ''),
+ ('&', 'and')]:
+ name = name.replace(from_, to)
+ return name
+
+ def __str__(self):
+ return str(self.__unicode__())
+
+ def __unicode__(self):
+ return '\n'.join([
+ 'Recipe: %s' % self.name,
+ 'Yield: %s' % self.yield_,
+ 'From: %s' % self.author,
+ 'Source: %s' % self.source,
+ 'URL: %s' % self.url,
+ '\n'.join([unicode(ib) for ib in self.ingredient_blocks]),
+ unicode(self.directions),
+ ])
+
+ def to_yaml(self):
+ d = {}
+ for key in ['name', 'ingredient_blocks', 'directions', 'yield_',
+ 'author', 'source', 'url', 'tags']:
+ d[key] = to_yaml_object(getattr(self, key))
+ return d
+
+ def from_yaml(self, dict):
+ for key in ['name', 'yield_', 'author', 'source', 'url', 'tags']:
+ setattr(self, key, dict.get(key, None))
+ self.ingredient_blocks = []
+ for ib in dict.get('ingredient_blocks', []):
+ ingredient_block = IngredientBlock()
+ ingredient_block.from_yaml(ib)
+ self.ingredient_blocks.append(ingredient_block)
+ self.directions = Directions()
+ self.directions.from_yaml(dict.get('directions', None))
+
+ def save(self, stream):
+ yaml.dump(self.to_yaml(), stream,
+ default_flow_style=False, allow_unicode=True, width=78)
+
+ def load(self, stream):
+ dict = yaml.load(stream)
+ self.from_yaml(dict)
+
+
+class Cookbook (list):
+ """
+ TODO: doctests
+ """
+ def __init__(self, name="Mom's cookbook", *args, **kwargs):
+ self.name = name
+ super(Cookbook, self).__init__(*args, **kwargs)
+
+ def save(self, dir='recipe'):
+ if not os.path.isdir(dir):
+ os.mkdir(dir)
+ paths = []
+ for recipe in self:
+ base_path = recipe.clean_name()
+ path = base_path
+ i = 2
+ while path in paths:
+ path = '%s_%d' % (base_path, i)
+ i += 1
+ for x in ['large']:
+ if x in path:
+ print paths[-4:]
+ paths.append(path)
+ with open(os.path.join(dir, path), 'w') as f:
+ recipe.save(f)
+
+ def load(self, dir='recipe'):
+ for path in os.listdir(dir):
+ r = Recipe()
+ with open(os.path.join(dir, path), 'r') as f:
+ r.load(f)
+ self.append(r)
+
+ def make_index(self):
+ self.index = {}
+ for recipe in self:
+ self.index[recipe.name] = recipe
+ self.index[recipe.clean_name()] = recipe
+
+
+def test():
+ import doctest
+ doctest.testmod()
--- /dev/null
+# Copyright
+
+"""Hack parser for standardizing my Mom's cookbook text.
+"""
+
+from .cookbook import (
+ Cookbook, Recipe, IngredientBlock, Ingredient, Amount, Directions)
+
+
+class MomParser (object):
+ def parse(self, filename):
+ c = Cookbook()
+ consecutive_blanks = 100
+ recipe_lines = None
+ for line in file(filename, 'r'):
+ line = line.strip().decode('utf-8')
+ if line == '':
+ if recipe_lines != None and consecutive_blanks == 0:
+ recipe_lines.append('')
+ consecutive_blanks += 1
+ continue
+ if consecutive_blanks >= 2:
+ if recipe_lines != None:
+ c.append(self._parse_recipe(recipe_lines))
+ recipe_lines = [line]
+ else:
+ recipe_lines.append(line)
+ consecutive_blanks = 0
+ return c
+
+ def _parse_recipe(self, lines):
+ name = lines.pop(0)
+ yield_,author,source,url,lines = self._parse_yield_line(lines)
+ ingredient_blocks,lines = self._parse_ingredient_blocks(lines)
+ directions,lines = self._parse_directions(lines)
+ assert len(lines) == 0, lines
+ return Recipe(
+ name=name,
+ ingredient_blocks=ingredient_blocks,
+ directions=directions,
+ yield_=yield_,
+ author=author,
+ source=source,
+ url=url)
+
+ def _parse_yield_line(self, lines):
+ while len(lines) > 0 and lines[0] == '':
+ lines.pop(0)
+ fields = ['yield', 'from', 'source', 'url']
+ yield_ = author = source = url = None
+ matching_line = False
+ for field in fields:
+ if field in lines[0].lower():
+ matching_line = True
+ break
+ if matching_line == True:
+ bits = lines.pop(0).split('\t')
+ for bit in bits:
+ for field in fields:
+ if bit.lower().startswith(field+':'):
+ value = bit[len(field+':'):].strip()
+ if field == 'yield':
+ yield_ = value.replace('Serving', 'serving')
+ elif field == 'from':
+ author = value
+ elif field == 'source':
+ source = value
+ elif field == 'url':
+ url = value
+ break
+ return (yield_, author, source, url, lines)
+
+ def _parse_ingredient_blocks(self, lines):
+ ingredient_blocks = []
+ first_block = True
+ while True:
+ while len(lines) > 0 and lines[0] == '': # scroll past blanks
+ lines.pop(0)
+ if (len(lines) == 0
+ or not (first_block == True
+ or lines[0].endswith(':'))):
+ break
+ if lines[0].endswith(':'):
+ line = lines.pop(0)
+ name = line[:-1].strip()
+ else:
+ name = None
+ block = IngredientBlock(name)
+ while len(lines) > 0 and lines[0] != '':
+ block.append(self._parse_ingredient_line(lines.pop(0)))
+ ingredient_blocks.append(block)
+ first_block = False
+ return (ingredient_blocks, lines)
+
+ def _parse_ingredient_line(self, line):
+ if line.lower().startswith('1 red'):
+ line = '1 # red'+line[len('1 red'):]
+ try:
+ value,units,name = line.split(' ', 2)
+ except ValueError:
+ print line,
+ raise
+ if units == '#':
+ units = None
+ elif units == 'Large':
+ units = 'large'
+ elif units == 'Cloves':
+ units = 'cloves'
+ return Ingredient(name, Amount(value, units))
+
+ def _parse_directions(self, lines):
+ directions = Directions()
+ paragraph = []
+ for line in lines:
+ if line == '':
+ if len(paragraph) > 0:
+ directions.append('\n'.join(paragraph))
+ paragraph = []
+ else:
+ paragraph.append(line)
+ return (directions, [])
--- /dev/null
+# Copyright
+
+"""Serve cookbooks over HTTP.
+"""
+
+import os
+import random
+import types
+from xml.sax import saxutils
+
+import cherrypy
+from jinja2 import Environment, FileSystemLoader
+
+
+class Server (object):
+ """Cookbook web interface."""
+
+ def __init__(self, cookbook, template_root):
+ self.cookbook = cookbook
+ self.cookbook.make_index()
+ self.env = Environment(loader=FileSystemLoader(template_root))
+
+ def cleanup(self):
+ #self.cookbook.save('new-recipe')
+ pass
+
+ @cherrypy.expose
+ def index(self, status='open', assignee='all', target='all'):
+ """Recipe index page.
+
+ Recipes can be filtered or sorted using a variety of criteria.
+ """
+ template = self.env.get_template('recipes.html')
+ return template.render(cookbook=self.cookbook,
+ recipes=list(self.cookbook))
+
+ @cherrypy.expose
+ def recipe(self, name=None):
+ """Single recipe page.
+ """
+ if name == None:
+ recipe = random.choice(self.cookbook)
+ else:
+ if type(name) == types.StringType:
+ name = unicode(name, encoding='utf-8')
+ recipe = self.cookbook.index[name]
+ template = self.env.get_template('recipe.html')
+ return template.render(cookbook=self.cookbook, recipe=recipe)
+#
+# @cherrypy.expose
+# def create(self, summary):
+# """The view that handles the creation of a new bug."""
+# if summary.strip() != '':
+# bugdir = self.storage_callbacks.get_bugdir()
+# bugdir.new_bug(summary=summary)
+# self.commit(u"Created bug: %s" % summary)
+# raise cherrypy.HTTPRedirect('/', status=302)
+#
+# @cherrypy.expose
+# def comment(self, id, body):
+# """The view that handles adding a comment."""
+# if body.strip() != '':
+# bugdir = self.storage_callbacks.get_bugdir()
+# bug = bugdir.bug_from_uuid(id)
+# bug.comment_root.new_reply(body=body)
+# self.commit(u"Added reply Re: %s" % bug.summary)
+# raise cherrypy.HTTPRedirect('/bug?id=%s' % (bug.uuid,), status=302)
+# raise cherrypy.HTTPRedirect('/', status=302)
+#
+# @cherrypy.expose
+# def edit(self, id, status=None, target=None, assignee=None, severity=None, summary=None):
+# """The view that handles editing bug details."""
+# bugdir = self.storage_callbacks.get_bugdir()
+# bug = bugdir.bug_from_uuid(id)
+#
+# if summary != None:
+# old_summary = bug.summary
+# bug.summary = summary
+# self.bd.vcs.commit("Changed bug summary: %s -> %s" % (old_summary, bug.summary))
+# else:
+# bug.status = status if status != 'None' else None
+# if target != 'None':
+# libbe.target.add_target(bugdir, bug, target)
+# bug.assigned = assignee if assignee != 'None' else None
+# bug.severity = severity if severity != 'None' else None
+# self.bd.vcs.commit("Changed bug values: %s" % bug.summary)
+#
+# raise cherrypy.HTTPRedirect('/bug?id=%s' % (bug.uuid,), status=302)
+
+def test():
+ import doctest
+ doctest.testmod()
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<html>
+ <head>
+ <title>{{ cookbook.name }}</title>
+<!--
+ <link rel="stylesheet" type="text/css" media="screen"
+ href="/static/style/aal.css" />
+ <link rel="stylesheet" type="text/css" media="screen"
+ href="/static/style/cfbe.css" />
+-->
+ </head>
+
+ <body>
+ <div id="main-pane">
+ <div id="header" class="inside-main-pane">
+ <h1>{{ cookbook.name }}</h1>
+ </div>
+<!--
+ <div id="navigation" class="inside-main-pane">
+ <span id="filters">
+ <a href="/">Open</a>
+ <a href="/?status=closed">Closed</a>
+ <a href="" id="filter-assignee">Assigned to...</a>
+ <a href="" id="filter-target">Scheduled for...</a>
+ </span>
+ <span id="create">
+ <a href="" id="create-bug">+ Create a new bug</a>
+ </span>
+ <span id="create-form">
+ <form action="/create" method="post">
+ <fieldset>
+ <input type="text"
+ id="create-summary" name="summary" />
+ <button id="create-button"
+ type="submit">Create</button>
+ </fieldset>
+ </form>
+ </span>
+ </div>
+ <div id="filter-pane" class="inside-main-pane"></div>
+-->
+ <div id="content-pane" class="inside-main-pane">
+ <h1>{% block page_title %}{% endblock %}</h1>
+ {% block content %}{% endblock %}
+ </div>
+ <div id="footer" class="inside-main-pane">
+ <p>
+ Powered by
+ <a href="http://www.physics.drexel.edu">Trevor King's</a>
+ <a href="">Cookbook</a>.
+ Built using <a href="http://cherrypy.org">CherryPy</a>
+ and <a href="http://jinja.pocoo.org/2/">Jinja2</a>.
+ </p>
+ </div>
+ </div>
+ </body>
+</html>
--- /dev/null
+{% extends "base.html" %}
+
+{% block page_title %}
+ {% if recipe.url %}
+ <a href="{{ recipe.url }}">{{ recipe.name }}</a>
+ {% else %}
+ {{ recipe.name }}
+ {% endif %}
+{% endblock %}
+
+{% block content %}
+ <p id="recipe-details">
+ {% if recipe.yield_ %}
+ <span class="detail-field-header">Yield:</span>
+ <span class="detail-field-contents">{{ recipe.yield_ }}</span><br />
+ {% endif %}
+ {% if recipe.author %}
+ <span class="detail-field-header">Author:</span>
+ <span class="detail-field-contents">{{ recipe.author }}</span><br />
+ {% endif %}
+ {% if recipe.source %}
+ <span class="detail-field-header">Source:</span>
+ <span class="detail-field-contents">{{ recipe.source }}</span><br />
+ {% endif %}
+
+ <div id="recipe-ingredient-blocks">
+ {% for ingredient_block in recipe.ingredient_blocks %}
+ <h2>{{ ingredient_block.heading() }}</h2>
+ <table>
+ {% for ingredient in ingredient_block %}
+ <tr>{{ ingredient.__unicode__() }}</tr>
+ {% endfor %}
+ </table>
+ {% endfor %}
+ </div>
+
+ <div id="recipe-directions">
+ <h2>Directions</h2>
+ {% for paragraph in recipe.directions.wrapped_paragraphs() %}
+ <p>{{ paragraph }}</p>
+ {% endfor %}
+ </div>
+{% endblock %}
--- /dev/null
+{% extends "base.html" %}
+
+{% block page_title %}
+ Index
+{% endblock %}
+
+{% block content %}
+ <ul id="recipe-list">
+ {% for recipe in recipes %}
+ <li><a href="/recipe?name={{ recipe.clean_name() }}">
+ {{ recipe.name }}</li>
+ {% endfor %}
+ </ul>
+{% endblock %}
--- /dev/null
+Volumes
+=======
+
+t. teaspoon
+T. tablespoon
+C. cup
+pt. pint
+qt. quart
+gal. gallon
+
+Weights
+=======
+
+oz. ounce
+lb. pound
+
+Lengths
+=======
+
+” inch
+
+Counts
+======
+
+doz. dozen (i.e. 12)
--- /dev/null
+#!/usr/bin/python
+#
+# Copyright
+
+"""Automatically update copyright boilerplate.
+
+This script is adapted from one written for `Bugs Everywhere`_.
+
+.. _Bugs Everywhere: http://bugseverywhere.org/
+"""
+
+import difflib
+import email.utils
+import os
+import os.path
+import re
+import sys
+import time
+
+
+PROJECT_INFO = {
+ 'project': 'Cookbook',
+ 'vcs': 'Git',
+ }
+
+# Break "copyright" into "copy" and "right" to avoid matching the
+# REGEXP.
+COPY_RIGHT_TEXT="""
+This file is part of %(project)s.
+
+%(project)s 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.
+
+%(project)s 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 %(project)s. If not, see <http://www.gnu.org/licenses/>.
+""".strip()
+
+COPY_RIGHT_TAG='-xyz-COPY' + '-RIGHT-zyx-' # unlikely to occur in the wild :p
+
+# Convert author names to canonical forms.
+# ALIASES[<canonical name>] = <list of aliases>
+# for example,
+# ALIASES = {
+# 'John Doe <jdoe@a.com>':
+# ['John Doe', 'jdoe', 'J. Doe <j@doe.net>'],
+# }
+# Git-based projects are encouraged to use .mailmap instead of
+# ALIASES. See git-shortlog(1) for details.
+ALIASES = {}
+
+# List of paths that should not be scanned for copyright updates.
+# IGNORED_PATHS = ['./.git/']
+IGNORED_PATHS = ['./.git/', './recipe/', './cookbook/static/',
+ './cookbook/template/']
+# List of files that should not be scanned for copyright updates.
+# IGNORED_FILES = ['COPYING']
+IGNORED_FILES = ['COPYING']
+
+# Work around missing author holes in the VCS history.
+# AUTHOR_HACKS[<path tuple>] = [<missing authors]
+# for example, if John Doe contributed to module.py but wasn't listed
+# in the VCS history of that file:
+# AUTHOR_HACKS = {
+# ('path', 'to', 'module.py'):['John Doe'],
+# }
+AUTHOR_HACKS = {}
+
+# Work around missing year holes in the VCS history.
+# YEAR_HACKS[<path tuple>] = <original year>
+# for example, if module.py was published in 2008 but the VCS history
+# only goes back to 2010:
+# YEAR_HACKS = {
+# ('path', 'to', 'module.py'):2008,
+# }
+YEAR_HACKS = {}
+
+# Helpers for VCS-specific commands
+
+def splitpath(path):
+ """Recursively split a path into elements.
+
+ Examples
+ --------
+
+ >>> splitpath(os.path.join('a', 'b', 'c'))
+ ('a', 'b', 'c')
+ >>> splitpath(os.path.join('.', 'a', 'b', 'c'))
+ ('a', 'b', 'c')
+ """
+ path = os.path.normpath(path)
+ elements = []
+ while True:
+ dirname,basename = os.path.split(path)
+ elements.insert(0,basename)
+ if dirname in ['', '.']:
+ break
+ path = dirname
+ return tuple(elements)
+
+# VCS-specific commands
+
+if PROJECT_INFO['vcs'] == 'Git':
+
+ import subprocess
+
+ _MSWINDOWS = sys.platform == 'win32'
+ _POSIX = not _MSWINDOWS
+
+ def invoke(args, stdin=None, stdout=subprocess.PIPE, stderr=subprocess.PIPE, expect=(0,)):
+ """
+ expect should be a tuple of allowed exit codes.
+ """
+ try :
+ if _POSIX:
+ q = subprocess.Popen(args, stdin=subprocess.PIPE,
+ stdout=stdout, stderr=stderr)
+ else:
+ assert _MSWINDOWS == True, 'invalid platform'
+ # win32 don't have os.execvp() so run the command in a shell
+ q = subprocess.Popen(args, stdin=subprocess.PIPE,
+ stdout=stdout, stderr=stderr, shell=True)
+ except OSError, e:
+ raise ValueError([args, e])
+ stdout,stderr = q.communicate(input=stdin)
+ status = q.wait()
+ if status not in expect:
+ raise ValueError([args, status, stdout, stderr])
+ return status, stdout, stderr
+
+ def git_cmd(*args):
+ status,stdout,stderr = invoke(['git'] + list(args))
+ return stdout.rstrip('\n')
+
+ def original_year(filename, year_hacks=YEAR_HACKS):
+ output = git_cmd('log', '--follow',
+ '--format=format:%ad', # Author date
+ '--date=short', # YYYY-MM-DD
+ filename)
+ years = [int(line.split('-', 1)[0]) for line in output.splitlines()]
+ if splitpath(filename) in year_hacks:
+ years.append(year_hacks[splitpath(filename)])
+ years.sort()
+ return years[0]
+
+ def authors(filename, author_hacks=AUTHOR_HACKS):
+ output = git_cmd('log', '--follow', '--format=format:%aN <%aE>',
+ filename) # Author name <author email>
+ ret = list(set(output.splitlines()))
+ if splitpath(filename) in author_hacks:
+ ret.extend(author_hacks[splitpath(filename)])
+ return ret
+
+ def authors_list(author_hacks=AUTHOR_HACKS):
+ output = git_cmd('log', '--format=format:%aN <%aE>')
+ ret = list(set(output.splitlines()))
+ for path,authors in author_hacks.items():
+ ret.extend(authors)
+ return ret
+
+ def is_versioned(filename):
+ output = git_cmd('log', '--follow', filename)
+ if len(output) == 0:
+ return False
+ return True
+
+elif PROJECT_INFO['vcs'] == 'Mercurial':
+
+ import StringIO
+ import mercurial
+ import mercurial.dispatch
+
+ def mercurial_cmd(*args):
+ cwd = os.getcwd()
+ stdout = sys.stdout
+ stderr = sys.stderr
+ tmp_stdout = StringIO.StringIO()
+ tmp_stderr = StringIO.StringIO()
+ sys.stdout = tmp_stdout
+ sys.stderr = tmp_stderr
+ try:
+ mercurial.dispatch.dispatch(list(args))
+ finally:
+ os.chdir(cwd)
+ sys.stdout = stdout
+ sys.stderr = stderr
+ return (tmp_stdout.getvalue().rstrip('\n'),
+ tmp_stderr.getvalue().rstrip('\n'))
+
+ def original_year(filename, year_hacks=YEAR_HACKS):
+ # shortdate filter: YEAR-MONTH-DAY
+ output,error = mercurial_cmd('log', '--follow',
+ '--template', '{date|shortdate}\n',
+ filename)
+ years = [int(line.split('-', 1)[0]) for line in output.splitlines()]
+ if splitpath(filename) in year_hacks:
+ years.append(year_hacks[splitpath(filename)])
+ years.sort()
+ return years[0]
+
+ def authors(filename, author_hacks=AUTHOR_HACKS):
+ output,error = mercurial_cmd('log', '--follow',
+ '--template', '{author}\n',
+ filename)
+ ret = list(set(output.splitlines()))
+ if splitpath(filename) in author_hacks:
+ ret.extend(author_hacks[splitpath(filename)])
+ return ret
+
+ def authors_list(author_hacks=AUTHOR_HACKS):
+ output,error = mercurial_cmd('log', '--template', '{author}\n')
+ ret = list(set(output.splitlines()))
+ for path,authors in author_hacks.items():
+ ret.extend(authors)
+ return ret
+
+ def is_versioned(filename):
+ output,error = mercurial_cmd('log', '--follow', filename)
+ if len(error) > 0:
+ return False
+ return True
+
+elif PROJECT_INFO['vcs'] == 'Bazaar':
+
+ import StringIO
+ import bzrlib
+ import bzrlib.builtins
+ import bzrlib.log
+
+ class LogFormatter (bzrlib.log.LogFormatter):
+ supports_merge_revisions = True
+ preferred_levels = 0
+ supports_deta = False
+ supports_tags = False
+ supports_diff = False
+
+ def log_revision(self, revision):
+ raise NotImplementedError
+
+ class YearLogFormatter (LogFormatter):
+ def log_revision(self, revision):
+ self.to_file.write(
+ time.strftime('%Y', time.gmtime(revision.rev.timestamp))
+ +'\n')
+
+ class AuthorLogFormatter (LogFormatter):
+ def log_revision(self, revision):
+ authors = revision.rev.get_apparent_authors()
+ self.to_file.write('\n'.join(authors)+'\n')
+
+ def original_year(filename, year_hacks=YEAR_HACKS):
+ cmd = bzrlib.builtins.cmd_log()
+ cmd.outf = StringIO.StringIO()
+ cmd.run(file_list=[filename], log_format=YearLogFormatter, levels=0)
+ years = [int(year) for year in set(cmd.outf.getvalue().splitlines())]
+ if splitpath(filename) in year_hacks:
+ years.append(year_hacks[splitpath(filename)])
+ years.sort()
+ return years[0]
+
+ def authors(filename, author_hacks=AUTHOR_HACKS):
+ cmd = bzrlib.builtins.cmd_log()
+ cmd.outf = StringIO.StringIO()
+ cmd.run(file_list=[filename], log_format=AuthorLogFormatter, levels=0)
+ ret = list(set(cmd.outf.getvalue().splitlines()))
+ if splitpath(filename) in author_hacks:
+ ret.extend(author_hacks[splitpath(filename)])
+ return ret
+
+ def authors_list(author_hacks=AUTHOR_HACKS):
+ cmd = bzrlib.builtins.cmd_log()
+ cmd.outf = StringIO.StringIO()
+ cmd.run(log_format=AuthorLogFormatter, levels=0)
+ output = cmd.outf.getvalue()
+ ret = list(set(cmd.outf.getvalue().splitlines()))
+ for path,authors in author_hacks.items():
+ ret.extend(authors)
+ return ret
+
+ def is_versioned(filename):
+ cmd = bzrlib.builtins.cmd_log()
+ cmd.outf = StringIO.StringIO()
+ cmd.run(file_list=[filename])
+ return True
+
+else:
+ raise NotImplementedError('Unrecognized VCS: %(vcs)s' % PROJECT_INFO)
+
+# General utility commands
+
+def _strip_email(*args):
+ """Remove email addresses from a series of names.
+
+ Examples
+ --------
+
+ >>> _strip_email('J Doe <jdoe@a.com>')
+ ['J Doe']
+ >>> _strip_email('J Doe <jdoe@a.com>', 'JJJ Smith <jjjs@a.com>')
+ ['J Doe', 'JJJ Smith']
+ """
+ args = list(args)
+ for i,arg in enumerate(args):
+ if arg == None:
+ continue
+ author,addr = email.utils.parseaddr(arg)
+ args[i] = author
+ return args
+
+def _reverse_aliases(aliases):
+ """Reverse an `aliases` dict.
+
+ Input: key: canonical name, value: list of aliases
+ Output: key: alias, value: canonical name
+
+ Examples
+ --------
+
+ >>> aliases = {
+ ... 'J Doe <jdoe@a.com>':['Johnny <jdoe@b.edu>', 'J'],
+ ... 'JJJ Smith <jjjs@a.com>':['Jingly <jjjs@b.edu>'],
+ ... None:['Anonymous <a@a.com>'],
+ ... }
+ >>> r = _reverse_aliases(aliases)
+ >>> for item in sorted(r.items()):
+ ... print item
+ ('Anonymous <a@a.com>', None)
+ ('J', 'J Doe <jdoe@a.com>')
+ ('Jingly <jjjs@b.edu>', 'JJJ Smith <jjjs@a.com>')
+ ('Johnny <jdoe@b.edu>', 'J Doe <jdoe@a.com>')
+ """
+ output = {}
+ for canonical_name,_aliases in aliases.items():
+ for alias in _aliases:
+ output[alias] = canonical_name
+ return output
+
+def _replace_aliases(authors, with_email=True, aliases=None):
+ """Consolidate and sort `authors`.
+
+ Make the replacements listed in the `aliases` dict (key: canonical
+ name, value: list of aliases). If `aliases` is ``None``, default
+ to ``ALIASES``.
+
+ >>> aliases = {
+ ... 'J Doe <jdoe@a.com>':['Johnny <jdoe@b.edu>'],
+ ... 'JJJ Smith <jjjs@a.com>':['Jingly <jjjs@b.edu>'],
+ ... None:['Anonymous <a@a.com>'],
+ ... }
+ >>> _replace_aliases(['JJJ Smith <jjjs@a.com>', 'Johnny <jdoe@b.edu>',
+ ... 'Jingly <jjjs@b.edu>', 'Anonymous <a@a.com>'],
+ ... with_email=True, aliases=aliases)
+ ['J Doe <jdoe@a.com>', 'JJJ Smith <jjjs@a.com>']
+ >>> _replace_aliases(['JJJ Smith', 'Johnny', 'Jingly', 'Anonymous'],
+ ... with_email=False, aliases=aliases)
+ ['J Doe', 'JJJ Smith']
+ >>> _replace_aliases(['JJJ Smith <jjjs@a.com>', 'Johnny <jdoe@b.edu>',
+ ... 'Jingly <jjjs@b.edu>', 'J Doe <jdoe@a.com>'],
+ ... with_email=True, aliases=aliases)
+ ['J Doe <jdoe@a.com>', 'JJJ Smith <jjjs@a.com>']
+ """
+ if aliases == None:
+ aliases = ALIASES
+ if with_email == False:
+ aliases = dict([(_strip_email(author)[0], _strip_email(*_aliases))
+ for author,_aliases in aliases.items()])
+ rev_aliases = _reverse_aliases(aliases)
+ for i,author in enumerate(authors):
+ if author in rev_aliases:
+ authors[i] = rev_aliases[author]
+ authors = sorted(list(set(authors)))
+ if None in authors:
+ authors.remove(None)
+ return authors
+
+def _copyright_string(original_year, final_year, authors, prefix=''):
+ """
+ >>> print _copyright_string(original_year=2005,
+ ... final_year=2005,
+ ... authors=['A <a@a.com>', 'B <b@b.edu>'],
+ ... prefix='# '
+ ... ) # doctest: +ELLIPSIS
+ # Copyright (C) 2005 A <a@a.com>
+ # B <b@b.edu>
+ #
+ # This file...
+ >>> print _copyright_string(original_year=2005,
+ ... final_year=2009,
+ ... authors=['A <a@a.com>', 'B <b@b.edu>']
+ ... ) # doctest: +ELLIPSIS
+ Copyright (C) 2005-2009 A <a@a.com>
+ B <b@b.edu>
+ <BLANKLINE>
+ This file...
+ """
+ if original_year == final_year:
+ date_range = '%s' % original_year
+ else:
+ date_range = '%s-%s' % (original_year, final_year)
+ lines = ['Copyright (C) %s %s' % (date_range, authors[0])]
+ for author in authors[1:]:
+ lines.append(' '*(len('Copyright (C) ')+len(date_range)+1) +
+ author)
+ lines.append('')
+ lines.extend((COPY_RIGHT_TEXT % PROJECT_INFO).splitlines())
+ for i,line in enumerate(lines):
+ lines[i] = (prefix + line).rstrip()
+ return '\n'.join(lines)
+
+def _tag_copyright(contents):
+ """
+ >>> contents = '''Some file
+ ... bla bla
+ ... # Copyright (copyright begins)
+ ... # (copyright continues)
+ ... # bla bla bla
+ ... (copyright ends)
+ ... bla bla bla
+ ... '''
+ >>> print _tag_copyright(contents).replace('COPY-RIGHT', 'CR')
+ Some file
+ bla bla
+ -xyz-CR-zyx-
+ (copyright ends)
+ bla bla bla
+ <BLANKLINE>
+ """
+ lines = []
+ incopy = False
+ for line in contents.splitlines():
+ if incopy == False and line.startswith('# Copyright'):
+ incopy = True
+ lines.append(COPY_RIGHT_TAG)
+ elif incopy == True and not line.startswith('#'):
+ incopy = False
+ if incopy == False:
+ lines.append(line.rstrip('\n'))
+ return '\n'.join(lines)+'\n'
+
+def _update_copyright(contents, original_year, authors):
+ """
+ >>> contents = '''Some file
+ ... bla bla
+ ... # Copyright (copyright begins)
+ ... # (copyright continues)
+ ... # bla bla bla
+ ... (copyright ends)
+ ... bla bla bla
+ ... '''
+ >>> print _update_copyright(contents, 2008, ['Jack', 'Jill']
+ ... ) # doctest: +ELLIPSIS, +REPORT_UDIFF
+ Some file
+ bla bla
+ # Copyright (C) 2008-... Jack
+ # Jill
+ #
+ # This file...
+ (copyright ends)
+ bla bla bla
+ <BLANKLINE>
+ """
+ current_year = time.gmtime()[0]
+ copyright_string = _copyright_string(
+ original_year, current_year, authors, prefix='# ')
+ contents = _tag_copyright(contents)
+ return contents.replace(COPY_RIGHT_TAG, copyright_string)
+
+def ignored_file(filename, ignored_paths=None, ignored_files=None,
+ check_disk=True, check_vcs=True):
+ """
+ >>> ignored_paths = ['./a/', './b/']
+ >>> ignored_files = ['x', 'y']
+ >>> ignored_file('./a/z', ignored_paths, ignored_files, False, False)
+ True
+ >>> ignored_file('./ab/z', ignored_paths, ignored_files, False, False)
+ False
+ >>> ignored_file('./ab/x', ignored_paths, ignored_files, False, False)
+ True
+ >>> ignored_file('./ab/xy', ignored_paths, ignored_files, False, False)
+ False
+ >>> ignored_file('./z', ignored_paths, ignored_files, False, False)
+ False
+ """
+ if ignored_paths == None:
+ ignored_paths = IGNORED_PATHS
+ if ignored_files == None:
+ ignored_files = IGNORED_FILES
+ if check_disk == True and os.path.isfile(filename) == False:
+ return True
+ for path in ignored_paths:
+ if filename.startswith(path):
+ return True
+ if os.path.basename(filename) in ignored_files:
+ return True
+ if check_vcs == True and is_versioned(filename) == False:
+ return True
+ return False
+
+def _set_contents(filename, contents, original_contents=None, dry_run=False,
+ verbose=0):
+ if original_contents == None and os.path.isfile(filename):
+ f = open(filename, 'r')
+ original_contents = f.read()
+ f.close()
+ if verbose > 0:
+ print "checking %s ... " % filename,
+ if contents != original_contents:
+ if verbose > 0:
+ if original_contents == None:
+ print "[creating]"
+ else:
+ print "[updating]"
+ if verbose > 1 and original_contents != None:
+ print '\n'.join(
+ difflib.unified_diff(
+ original_contents.splitlines(), contents.splitlines(),
+ fromfile=os.path.normpath(os.path.join('a', filename)),
+ tofile=os.path.normpath(os.path.join('b', filename)),
+ n=3, lineterm=''))
+ if dry_run == False:
+ f = file(filename, 'w')
+ f.write(contents)
+ f.close()
+ elif verbose > 0:
+ print "[no change]"
+
+# Update commands
+
+def update_authors(authors_fn=authors_list, dry_run=False, verbose=0):
+ authors = authors_fn()
+ authors = _replace_aliases(authors, with_email=True, aliases=ALIASES)
+ new_contents = '%s was written by:\n%s\n' % (
+ PROJECT_INFO['project'],
+ '\n'.join(authors)
+ )
+ _set_contents('AUTHORS', new_contents, dry_run=dry_run, verbose=verbose)
+
+def update_file(filename, original_year_fn=original_year, authors_fn=authors,
+ dry_run=False, verbose=0):
+ f = file(filename, 'r')
+ contents = f.read()
+ f.close()
+
+ original_year = original_year_fn(filename)
+ authors = authors_fn(filename)
+ authors = _replace_aliases(authors, with_email=True, aliases=ALIASES)
+
+ new_contents = _update_copyright(contents, original_year, authors)
+ _set_contents(filename, contents=new_contents, original_contents=contents,
+ dry_run=dry_run, verbose=verbose)
+
+def update_files(files=None, dry_run=False, verbose=0):
+ if files == None or len(files) == 0:
+ files = []
+ for dirpath,dirnames,filenames in os.walk('.'):
+ for filename in filenames:
+ files.append(os.path.join(dirpath, filename))
+
+ for filename in files:
+ if ignored_file(filename) == True:
+ continue
+ update_file(filename, dry_run=dry_run, verbose=verbose)
+
+def test():
+ import doctest
+ doctest.testmod()
+
+if __name__ == '__main__':
+ import optparse
+ import sys
+
+ usage = """%%prog [options] [file ...]
+
+Update copyright information in source code with information from
+the %(vcs)s repository. Run from the %(project)s repository root.
+
+Replaces every line starting with '^# Copyright' and continuing with
+'^#' with an auto-generated copyright blurb. If you want to add
+#-commented material after a copyright blurb, please insert a blank
+line between the blurb and your comment, so the next run of
+``update_copyright.py`` doesn't clobber your comment.
+
+If no files are given, a list of files to update is generated
+automatically.
+""" % PROJECT_INFO
+ p = optparse.OptionParser(usage)
+ p.add_option('--test', dest='test', default=False,
+ action='store_true', help='Run internal tests and exit')
+ p.add_option('--dry-run', dest='dry_run', default=False,
+ action='store_true', help="Don't make any changes")
+ p.add_option('-v', '--verbose', dest='verbose', default=0,
+ action='count', help='Increment verbosity')
+ options,args = p.parse_args()
+
+ if options.test == True:
+ test()
+ sys.exit(0)
+
+ update_authors(dry_run=options.dry_run, verbose=options.verbose)
+ update_files(files=args, dry_run=options.dry_run, verbose=options.verbose)
projects / cookbook.git / commitdiff