diff --git a/examples/bob.example.extension/.gitignore b/examples/bob.example.extension/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..b8afedd4fabe76662e1ef277c0a7b285fc0ff256 --- /dev/null +++ b/examples/bob.example.extension/.gitignore @@ -0,0 +1,13 @@ +*~ +*.swp +*.pyc +bin +eggs +parts +.installed.cfg +.mr.developer.cfg +*.egg-info +src +develop-eggs +sphinx +dist diff --git a/examples/bob.example.extension/COPYING b/examples/bob.example.extension/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/examples/bob.example.extension/COPYING @@ -0,0 +1,674 @@ + 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>. diff --git a/examples/bob.example.extension/MANIFEST.in b/examples/bob.example.extension/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..e129ae10dcb019c6bcf525ffd34a3c28384c83f0 --- /dev/null +++ b/examples/bob.example.extension/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst bootstrap.py buildout.cfg COPYING +recursive-include doc *.py *.rst diff --git a/examples/bob.example.extension/README.rst b/examples/bob.example.extension/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..92335dac2ab1a8d17ba3d542dae576bb846e9be1 --- /dev/null +++ b/examples/bob.example.extension/README.rst @@ -0,0 +1,28 @@ +Example buildout environment +============================ + +This simple example demonstrates how to wrap Bob-based scripts on buildout +environments. This may be useful for homework assignments, tests or as a way to +distribute code to reproduce your publication. In summary, if you need to give +out code to others, we recommend you do it following this template so your code +can be tested, documented and run in an orderly fashion. + +Installation +------------ + +.. note:: + + To follow these instructions locally you will need a local copy of this + package. For that, you can use the github tarball API to download the package:: + + $ wget --no-check-certificate https://github.com/idiap/bob.project.example/tarball/master -O- | tar xz + $ mv idiap-bob.project* bob.project.example + +Documentation and Further Information +------------------------------------- + +Please refer to the latest Bob user guide, accessing from the `Bob website +<http://idiap.github.com/bob/>`_ for how to create your own packages based on +this example. In particular, the Section entitled `Organize Your Work in +Satellite Packages <http://www.idiap.ch/software/bob/docs/releases/last/sphinx/html/OrganizeYourCode.html>`_ +contains details on how to setup, build and roll out your code. diff --git a/examples/bob.example.extension/bob/__init__.py b/examples/bob.example.extension/bob/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.extension/bob/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.extension/bob/example/__init__.py b/examples/bob.example.extension/bob/example/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.extension/bob/example/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.extension/bob/example/extension/Function.cpp b/examples/bob.example.extension/bob/example/extension/Function.cpp new file mode 100644 index 0000000000000000000000000000000000000000..748d85fe376ca6969fa0a93e19f10f9e1a80e7aa --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/Function.cpp @@ -0,0 +1,15 @@ +#include <blitz/array.h> + +/** + Simple example of a function dealing with a blitz array +*/ +blitz::Array<double,1> reverse (const blitz::Array<double,1>& array){ + // create new array in the desired shape + blitz::Array<double,1> retval(array.shape()); + // copy data + for (int i = 0, j = array.extent(0)-1; i < array.extent(0); ++i, --j){ + retval(j) = array(i); + } + // return the copied data + return retval; +} diff --git a/examples/bob.example.extension/bob/example/extension/__init__.py b/examples/bob.example.extension/bob/example/extension/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..073a8aa2fdc5823eb0cfcda847972728994d6e13 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/__init__.py @@ -0,0 +1,34 @@ +# import all packages with direct dependencies +# (This will load their pure C++ libraries, if needed) +import bob.blitz +# ... in fact, bob.blitz does not have a C++ library and it would not be needed to import it here +# ... nevertheless, it stays here not to forget it! + + +# import the C++ function ``reverse`` from the library +from ._library import reverse + +# import the ``version`` library as well +from . import version as _version +version = _version.module + +def get_config(): + """Returns a string containing the configuration information. + """ + + import pkg_resources + + packages = pkg_resources.require(__name__) + this = packages[0] + deps = packages[1:] + + retval = "%s: %s (%s)\n" % (this.key, this.version, this.location) + retval += " - c/c++ dependencies:\n" + for k in sorted(_version.externals): retval += " - %s: %s\n" % (k, _version.externals[k]) + retval += " - python dependencies:\n" + for d in deps: retval += " - %s: %s (%s)\n" % (d.key, d.version, d.location) + + return retval.strip() + +# gets sphinx autodoc done right - don't remove it +__all__ = [_ for _ in dir() if not _.startswith('_')] diff --git a/examples/bob.example.extension/bob/example/extension/main.cpp b/examples/bob.example.extension/bob/example/extension/main.cpp new file mode 100644 index 0000000000000000000000000000000000000000..283f631c5a33d4ea2c00b3cde92a8f70606378d4 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/main.cpp @@ -0,0 +1,112 @@ +// include directly and indirectly dependent libraries +#ifdef NO_IMPORT_ARRAY +#undef NO_IMPORT_ARRAY +#endif +#include <bob.blitz/cppapi.h> +#include <bob.blitz/cleanup.h> +#include <bob.extension/documentation.h> + + +// declare C++ function +extern blitz::Array<double,1> reverse (const blitz::Array<double,1>&); + +// use the documentation classes to document the function +static bob::extension::FunctionDoc reverse_doc = bob::extension::FunctionDoc( + "reverse", + "This is a simple example of bridging between blitz arrays (C++) and numpy.ndarrays (Python)", + "Detailed documentation of the function goes here." +) +.add_prototype("array", "reversed") +.add_parameter("array", "array_like (1D, float)", "The array to reverse") +.add_return("reversed", "array_like (1D, float)", "A copy of the ``array`` with reversed order of entries") +; + +// declare the function +// we use the default Python C-API here. +static PyObject* PyReverse(PyObject*, PyObject* args, PyObject* kwargs) { + // declare the expected parameter names + char* kwlist[] = {const_cast<char*>("array"), NULL}; + + // declare an object of the bridging type + PyBlitzArrayObject* array; + // ... and get the command line argument + if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&", kwlist, &PyBlitzArray_Converter, &array)) return 0; + + // since PyBlitzArray_Converter increased the reference count of array, + // assure that the reference is decreased when the function exits (either way) + auto array_ = make_safe(array); + + // check that the array has the expected properties + if (array->type_num != NPY_FLOAT64 || array->ndim != 1){ + PyErr_Format(PyExc_TypeError, "%s : Only 1D arrays of type float are allowed", reverse_doc.name()); + return 0; + } + + // extract the actual blitz array from the Python type + blitz::Array<double, 1> bz = *PyBlitzArrayCxx_AsBlitz<double, 1>(array); + + // call the C++ function + blitz::Array<double, 1> reversed = reverse(bz); + + // convert the blitz array back to numpy and return it + return PyBlitzArrayCxx_AsNumpy(reversed); +} + + +////////////////////////////////////////////////////////////////////////// +/////// Python module declaration //////////////////////////////////////// +////////////////////////////////////////////////////////////////////////// + +// module-wide methods +static PyMethodDef module_methods[] = { + { + reverse_doc.name(), + (PyCFunction)PyReverse, + METH_VARARGS|METH_KEYWORDS, + reverse_doc.doc() + }, + {NULL} // Sentinel +}; + +// module documentation +PyDoc_STRVAR(module_docstr, "Exemplary Python Bindings"); + +// module definition +#if PY_VERSION_HEX >= 0x03000000 +static PyModuleDef module_definition = { + PyModuleDef_HEAD_INIT, + BOB_EXT_MODULE_NAME, + module_docstr, + -1, + module_methods, + 0, 0, 0, 0 +}; +#endif + +// create the module +static PyObject* create_module (void) { + +# if PY_VERSION_HEX >= 0x03000000 + PyObject* module = PyModule_Create(&module_definition); +# else + PyObject* module = Py_InitModule3(BOB_EXT_MODULE_NAME, module_methods, module_docstr); +# endif + if (!module) return 0; + auto module_ = make_safe(module); ///< protects against early returns + + if (PyModule_AddStringConstant(module, "__version__", BOB_EXT_MODULE_VERSION) < 0) return 0; + + /* imports bob.blitz C-API + dependencies */ + if (import_bob_blitz() < 0) return 0; + + Py_INCREF(module); + return module; + +} + +PyMODINIT_FUNC BOB_EXT_ENTRY_NAME (void) { +# if PY_VERSION_HEX >= 0x03000000 + return +# endif + create_module(); +} diff --git a/examples/bob.example.extension/bob/example/extension/script/__init__.py b/examples/bob.example.extension/bob/example/extension/script/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/examples/bob.example.extension/bob/example/extension/script/reverse.py b/examples/bob.example.extension/bob/example/extension/script/reverse.py new file mode 100644 index 0000000000000000000000000000000000000000..e1591ebf6c0553f20a3da37ac14e9836fbd6d378 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/script/reverse.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Sun 15 Apr 14:01:39 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Inverts the list of floating point numbers given on command line +""" + +from .._library import reverse + +def main(): + """Main routine, called by the script that gets the configuration of bob.blitz""" + + import sys + if len(sys.argv) == 1: + print ("Usage: %s <numbers>\n" % sys.argv[0]) + return + + numbers = [float(n) for n in sys.argv[1:]] + print (numbers) + rev = reverse(numbers) + + print ("%s reversed is %s" % (numbers, rev)) diff --git a/examples/bob.example.extension/bob/example/extension/script/version.py b/examples/bob.example.extension/bob/example/extension/script/version.py new file mode 100644 index 0000000000000000000000000000000000000000..827eaafa916468be7bbdc36c611c79bd1ae45e83 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/script/version.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Sun 15 Apr 14:01:39 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Prints the version of bob and exits +""" + +def main(): + """Main routine, called by the script that gets the configuration of bob.blitz""" + + import bob.blitz + print (bob.blitz.get_config()) + diff --git a/examples/bob.example.extension/bob/example/extension/test.py b/examples/bob.example.extension/bob/example/extension/test.py new file mode 100644 index 0000000000000000000000000000000000000000..785f3782a384b8e5adb778e887b810391f679e45 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/test.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Wed 15 Aug 09:59:33 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Test Units +""" + +def test_reverse(): + from . import reverse + source = [0., 1., 2., 3., 4.] + target = reverse(source) + for i in range(5): + assert target[i] == source[4-i] + diff --git a/examples/bob.example.extension/bob/example/extension/version.cpp b/examples/bob.example.extension/bob/example/extension/version.cpp new file mode 100644 index 0000000000000000000000000000000000000000..1e037cc73f725c8066b48d24f0f47ab5d90c6fa5 --- /dev/null +++ b/examples/bob.example.extension/bob/example/extension/version.cpp @@ -0,0 +1,157 @@ +/** + * @author Andre Anjos <andre.anjos@idiap.ch> + * @date Thu 7 Nov 13:50:16 2013 + * + * @brief Binds configuration information available from bob + */ + +#ifdef NO_IMPORT_ARRAY +#undef NO_IMPORT_ARRAY +#endif +#include <bob.blitz/capi.h> +#include <bob.blitz/cleanup.h> + +#include <string> +#include <cstdlib> +#include <blitz/blitz.h> +#include <boost/preprocessor/stringize.hpp> +#include <boost/version.hpp> +#include <boost/format.hpp> + + +static int dict_set(PyObject* d, const char* key, const char* value) { + PyObject* v = Py_BuildValue("s", value); + if (!v) return 0; + auto v_ = make_safe(v); + int retval = PyDict_SetItemString(d, key, v); + if (retval == 0) return 1; //all good + return 0; //a problem occurred +} + +static int dict_steal(PyObject* d, const char* key, PyObject* value) { + if (!value) return 0; + auto value_ = make_safe(value); + int retval = PyDict_SetItemString(d, key, value); + if (retval == 0) return 1; //all good + return 0; //a problem occurred +} + +/*********************************************************** + * Version number generation + ***********************************************************/ + +/** + * Describes the compiler version + */ +static PyObject* compiler_version() { +# if defined(__GNUC__) && !defined(__llvm__) + boost::format f("%s.%s.%s"); + f % BOOST_PP_STRINGIZE(__GNUC__); + f % BOOST_PP_STRINGIZE(__GNUC_MINOR__); + f % BOOST_PP_STRINGIZE(__GNUC_PATCHLEVEL__); + return Py_BuildValue("{ssss}", "name", "gcc", "version", f.str().c_str()); +# elif defined(__llvm__) && !defined(__clang__) + return Py_BuildValue("{ssss}", "name", "llvm-gcc", "version", __VERSION__); +# elif defined(__clang__) + return Py_BuildValue("{ssss}", "name", "clang", "version", __clang_version__); +# else + return Py_BuildValue("{ssss}", "name", "unsupported", "version", "unknown"); +# endif +} + +/** + * Python version with which we compiled the extensions + */ +static PyObject* python_version() { + boost::format f("%s.%s.%s"); + f % BOOST_PP_STRINGIZE(PY_MAJOR_VERSION); + f % BOOST_PP_STRINGIZE(PY_MINOR_VERSION); + f % BOOST_PP_STRINGIZE(PY_MICRO_VERSION); + return Py_BuildValue("s", f.str().c_str()); +} + +/** + * Numpy version + */ +static PyObject* numpy_version() { + return Py_BuildValue("{ssss}", "abi", BOOST_PP_STRINGIZE(NPY_VERSION), "api", BOOST_PP_STRINGIZE(NPY_API_VERSION)); +} + +/** + * bob.blitz c/c++ api version + */ +static PyObject* bob_blitz_version() { + return Py_BuildValue("{ss}", "api", BOOST_PP_STRINGIZE(BOB_BLITZ_API_VERSION)); +} + + +// builds the dictionary of versions +static PyObject* build_version_dictionary() { + + PyObject* retval = PyDict_New(); + if (!retval) return 0; + auto retval_ = make_safe(retval); + + if (!dict_steal(retval, "Compiler", compiler_version())) return 0; + if (!dict_steal(retval, "Python", python_version())) return 0; + if (!dict_steal(retval, "NumPy", numpy_version())) return 0; + if (!dict_set(retval, "Blitz++", BZ_VERSION)) return 0; + if (!dict_steal(retval, "bob.blitz", bob_blitz_version())) return 0; + + Py_INCREF(retval); + Py_INCREF(retval); + return retval; +} + +static PyMethodDef module_methods[] = { + {0} /* Sentinel */ +}; + +PyDoc_STRVAR(module_docstr, +"Information about software used to compile the C++ Bob API" +); + +#if PY_VERSION_HEX >= 0x03000000 +static PyModuleDef module_definition = { + PyModuleDef_HEAD_INIT, + BOB_EXT_MODULE_NAME, + module_docstr, + -1, + module_methods, + 0, 0, 0, 0 +}; +#endif + +static PyObject* create_module (void) { + +# if PY_VERSION_HEX >= 0x03000000 + PyObject* m = PyModule_Create(&module_definition); +# else + PyObject* m = Py_InitModule3(BOB_EXT_MODULE_NAME, module_methods, module_docstr); +# endif + if (!m) return 0; + auto m_ = make_safe(m); ///< protects against early returns + + /* register version numbers and constants */ + if (PyModule_AddStringConstant(m, "module", BOB_EXT_MODULE_VERSION) < 0) + return 0; + if (PyModule_AddObject(m, "externals", build_version_dictionary()) < 0) return 0; + + /* imports dependencies */ + if (import_bob_blitz() < 0) { + PyErr_Print(); + PyErr_Format(PyExc_ImportError, "cannot import `%s'", BOB_EXT_MODULE_NAME); + return 0; + } + + Py_INCREF(m); + return m; + +} + +PyMODINIT_FUNC BOB_EXT_ENTRY_NAME (void) { +# if PY_VERSION_HEX >= 0x03000000 + return +# endif + create_module(); +} diff --git a/examples/bob.example.extension/bootstrap.py b/examples/bob.example.extension/bootstrap.py new file mode 100644 index 0000000000000000000000000000000000000000..2ec152f662355e3288f20f1a80afcdd710cfdea5 --- /dev/null +++ b/examples/bob.example.extension/bootstrap.py @@ -0,0 +1,183 @@ +############################################################################## +# +# 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 +import shutil +import sys +import tempfile + +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +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 --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +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", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install setuptools + +to_reload = False +try: + import pkg_resources + import setuptools +except ImportError: + ez = {} + + try: + from urllib.request import urlopen + except ImportError: + from urllib2 import urlopen + + # XXX use a more permanent ez_setup.py URL when available. + exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py' + ).read(), ez) + setup_args = dict(to_dir=tmpeggs, download_delay=0) + ez['use_setuptools'](**setup_args) + + if to_reload: + reload(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) + +###################################################################### +# Try to best guess the version of buildout given setuptools +if options.version is None: + + try: + from distutils.version import LooseVersion + package = pkg_resources.require('setuptools')[0] + v = LooseVersion(package.version) + if v < LooseVersion('0.7'): + options.version = '2.1.1' + except: + pass + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +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=[setuptools_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) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: + raise Exception( + "Failed to execute command:\n%s", + repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff --git a/examples/bob.example.extension/buildout.cfg b/examples/bob.example.extension/buildout.cfg new file mode 100644 index 0000000000000000000000000000000000000000..ffd0f454a239bbd1d669bfc8aae687e6be462943 --- /dev/null +++ b/examples/bob.example.extension/buildout.cfg @@ -0,0 +1,18 @@ +; vim: set fileencoding=utf-8 : +; Manuel Guenther <manuel.guenther@idiap.ch> +; Thu Oct 9 16:51:06 CEST 2014 + +[buildout] +parts = scripts +eggs = bob.example.extension +extensions = bob.buildout + +develop = . + +; options for bob.buildout +debug = true +verbose = true +newest = false + +[scripts] +recipe = bob.buildout:scripts diff --git a/examples/bob.example.extension/doc/conf.py b/examples/bob.example.extension/doc/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..b818e39edd463b2bb71606625fc53a2370b6abbf --- /dev/null +++ b/examples/bob.example.extension/doc/conf.py @@ -0,0 +1,253 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 13 Aug 2012 12:38:15 CEST +# +# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +import os +import sys +import glob +import pkg_resources + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.pngmath', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + ] + +# The viewcode extension appeared only on Sphinx >= 1.0.0 +import sphinx +if sphinx.__version__ >= "1.0": + extensions.append('sphinx.ext.viewcode') + +# Always includes todos +todo_include_todos = True + +# If we are on OSX, the 'dvipng' path maybe different +dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng' +if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Bob Example Project' +import time +copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') + +# Grab the setup entry +distribution = pkg_resources.require('bob.example.extension')[0] + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = distribution.version +# The full version, including alpha/beta/rc tags. +release = distribution.version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +#exclude_patterns = ['**/links.rst'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +if sphinx.__version__ >= "1.0": + html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = 'bob' + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bob_example_extension_doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +latex_paper_size = 'a4' + +# The font size ('10pt', '11pt' or '12pt'). +latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'bob_example_extension.tex', u'Bob', + u'Biometrics Group, Idiap Research Institute', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = '' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# Included after all input documents +rst_epilog = '' + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'bob.example.extension', u'Bob Example Extension Documentation', [u'Idiap Research Institute'], 1) +] + +# Default processing flags for sphinx +autoclass_content = 'both' +autodoc_member_order = 'bysource' +autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance'] + +# For inter-documentation mapping: +from bob.extension.utils import link_documentation +intersphinx_mapping = link_documentation() + + +def setup(app): + pass diff --git a/examples/bob.example.extension/doc/index.rst b/examples/bob.example.extension/doc/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..ac26ac833106e5e918a8b78520adf4956cc5a603 --- /dev/null +++ b/examples/bob.example.extension/doc/index.rst @@ -0,0 +1,15 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Mon 13 Aug 2012 12:36:40 CEST + +======================= + Bob Example Extension +======================= + + +Package Documentation +--------------------- + +.. automodule:: bob.example.extension + + diff --git a/examples/bob.example.extension/requirements.txt b/examples/bob.example.extension/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..0d5737b0d27e716b02c8ce942af53ef20ec8cdfe --- /dev/null +++ b/examples/bob.example.extension/requirements.txt @@ -0,0 +1 @@ +bob.blitz diff --git a/examples/bob.example.extension/setup.py b/examples/bob.example.extension/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..895f126c07d27d7acb5dbfb1aac370f742cf2ba4 --- /dev/null +++ b/examples/bob.example.extension/setup.py @@ -0,0 +1,174 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 16 Apr 08:18:08 2012 CEST +# +# Copyright (C) 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/>. + +# This file contains the python (distutils/setuptools) instructions so your +# package can be installed on **any** host system. It defines some basic +# information like the package name for instance, or its homepage. +# +# It also defines which other packages this python package depends on and that +# are required for this package's operation. The python subsystem will make +# sure all dependent packages are installed or will install them for you upon +# the installation of this package. +# +# The 'buildout' system we use here will go further and wrap this package in +# such a way to create an isolated python working environment. Buildout will +# make sure that dependencies which are not yet installed do get installed, but +# **without** requiring administrative privileges on the host system. This +# allows you to test your package with new python dependencies w/o requiring +# administrative interventions. + + + +# Add here other bob packages that your module depend on +setup_packages = ['bob.extension', 'bob.blitz'] +bob_packages = [] + +from setuptools import setup, find_packages, dist +dist.Distribution(dict(setup_requires = setup_packages + bob_packages)) + +# import the Extension class and the build_ext function from bob.blitz +from bob.blitz.extension import Extension, build_ext + +# load the requirements.txt for additional requirements +from bob.extension.utils import load_requirements +build_requires = setup_packages + bob_packages + load_requirements() + +# read version from "version.txt" file +version = open("version.txt").read().rstrip() + + +# The only thing we do in this file is to call the setup() function with all +# parameters that define our package. +setup( + + # This is the basic information about your project. Modify all this + # information before releasing code publicly. + name = 'bob.example.extension', + version = version, + description = 'Example for using Bob inside a C++ extension of a buildout project', + + url = 'https://www.github.com/<YourInstitution>/<YourPackage>', + license = 'GPLv3', + author = '<YourName>', + author_email='<YourEmail>', + keywords='bob, extension', + + # If you have a better, long description of your package, place it on the + # 'doc' directory and then hook it here + long_description = open('README.rst').read(), + + # This line is required for any distutils based packaging. + packages = find_packages(), + include_package_data = True, + + # These lines define which packages should be installed when you "install" + # this package. All packages that are mentioned here, but are not installed + # on the current system will be installed locally and only visible to the + # scripts of this package. Don't worry - You won't need administrative + # privileges when using buildout. + setup_requires = build_requires, + install_requires = build_requires, + + # Your project should be called something like 'bob.<foo>' or + # 'bob.<foo>.<bar>'. To implement this correctly and still get all your + # packages to be imported w/o problems, you need to implement namespaces + # on the various levels of the package and declare them here. See more + # about this here: + # http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages + # + # Our database packages are good examples of namespace implementations + # using several layers. You can check them out here: + # https://github.com/idiap/bob/wiki/Satellite-Packages + namespace_packages = [ + 'bob', + 'bob.example', + ], + + # In fact, we are defining two extensions here. In any case, you can define + # as many extensions as you need. Each of them will be compiled + # independently into a separate .so file. + ext_modules = [ + + # The first extension defines the version of this package and all C++-dependencies. + Extension("bob.example.extension.version", + # list of files compiled into this extension + [ + "bob/example/extension/version.cpp", + ], + # additional parameters, see Extension documentation + version = version, + bob_packages = bob_packages, + ), + + # The second extension contains the actual C++ code and the Python bindings + Extension("bob.example.extension._library", + # list of files compiled into this extension + [ + # the pure C++ code + "bob/example/extension/Function.cpp", + # the Python bindings + "bob/example/extension/main.cpp", + ], + # additional parameters, see Extension documentation + version = version, + bob_packages = bob_packages, + ), + ], + + # Important! We need to tell setuptools that we want the extension to be + # compiled with our build_ext function! + cmdclass = { + 'build_ext': build_ext, + }, + + # This entry defines which scripts you will have inside the 'bin' directory + # once you install the package (or run 'bin/buildout'). The order of each + # entry under 'console_scripts' is like this: + # script-name-at-bin-directory = module.at.your.library:function + # + # The module.at.your.library is the python file within your library, using + # the python syntax for directories (i.e., a '.' instead of '/' or '\'). + # This syntax also omits the '.py' extension of the filename. So, a file + # installed under 'example/foo.py' that contains a function which + # implements the 'main()' function of particular script you want to have + # should be referred as 'example.foo:main'. + # + # In this simple example we will create a single program that will print + # the version of bob. + entry_points = { + + # scripts should be declared using this entry: + 'console_scripts' : [ + 'reverse.py = bob.example.extension.script.reverse:main', + ], + }, + + # Classifiers are important if you plan to distribute this package through + # PyPI. You can find the complete list of classifiers that are valid and + # useful here (http://pypi.python.org/pypi?%3Aaction=list_classifiers). + classifiers = [ + 'Framework :: Bob', + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'Natural Language :: English', + 'Programming Language :: Python', + 'Topic :: Scientific/Engineering :: Artificial Intelligence', + ], +) diff --git a/examples/bob.example.extension/version.txt b/examples/bob.example.extension/version.txt new file mode 100644 index 0000000000000000000000000000000000000000..8ea4f48f6ca5b5149a254c16b97801cb338d7011 --- /dev/null +++ b/examples/bob.example.extension/version.txt @@ -0,0 +1 @@ +0.0.1a0 diff --git a/examples/bob.example.library/.gitignore b/examples/bob.example.library/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..b8afedd4fabe76662e1ef277c0a7b285fc0ff256 --- /dev/null +++ b/examples/bob.example.library/.gitignore @@ -0,0 +1,13 @@ +*~ +*.swp +*.pyc +bin +eggs +parts +.installed.cfg +.mr.developer.cfg +*.egg-info +src +develop-eggs +sphinx +dist diff --git a/examples/bob.example.library/COPYING b/examples/bob.example.library/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/examples/bob.example.library/COPYING @@ -0,0 +1,674 @@ + 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>. diff --git a/examples/bob.example.library/MANIFEST.in b/examples/bob.example.library/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..e129ae10dcb019c6bcf525ffd34a3c28384c83f0 --- /dev/null +++ b/examples/bob.example.library/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst bootstrap.py buildout.cfg COPYING +recursive-include doc *.py *.rst diff --git a/examples/bob.example.library/README.rst b/examples/bob.example.library/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..92335dac2ab1a8d17ba3d542dae576bb846e9be1 --- /dev/null +++ b/examples/bob.example.library/README.rst @@ -0,0 +1,28 @@ +Example buildout environment +============================ + +This simple example demonstrates how to wrap Bob-based scripts on buildout +environments. This may be useful for homework assignments, tests or as a way to +distribute code to reproduce your publication. In summary, if you need to give +out code to others, we recommend you do it following this template so your code +can be tested, documented and run in an orderly fashion. + +Installation +------------ + +.. note:: + + To follow these instructions locally you will need a local copy of this + package. For that, you can use the github tarball API to download the package:: + + $ wget --no-check-certificate https://github.com/idiap/bob.project.example/tarball/master -O- | tar xz + $ mv idiap-bob.project* bob.project.example + +Documentation and Further Information +------------------------------------- + +Please refer to the latest Bob user guide, accessing from the `Bob website +<http://idiap.github.com/bob/>`_ for how to create your own packages based on +this example. In particular, the Section entitled `Organize Your Work in +Satellite Packages <http://www.idiap.ch/software/bob/docs/releases/last/sphinx/html/OrganizeYourCode.html>`_ +contains details on how to setup, build and roll out your code. diff --git a/examples/bob.example.library/bob/__init__.py b/examples/bob.example.library/bob/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.library/bob/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.library/bob/example/__init__.py b/examples/bob.example.library/bob/example/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.library/bob/example/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.library/bob/example/library/__init__.py b/examples/bob.example.library/bob/example/library/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..2e5eac780a5a30349bea4b3cedf5eb947abe1ee3 --- /dev/null +++ b/examples/bob.example.library/bob/example/library/__init__.py @@ -0,0 +1,38 @@ +# import all packages with direct dependencies +# (This will load their pure C++ libraries, if needed) +import bob.blitz +# ... in fact, bob.blitz does not have a C++ library and it would not be needed to import it here +# ... nevertheless, it stays here not to forget it! + +# now, we have to load our own library +import bob.extension +bob.extension.load_bob_library('bob.example.library', __file__) + + +# import the C++ function ``reverse`` from the library +from ._library import reverse + +# import the ``version`` library as well +from . import version as _version +version = _version.module + +def get_config(): + """Returns a string containing the configuration information. + """ + + import pkg_resources + + packages = pkg_resources.require(__name__) + this = packages[0] + deps = packages[1:] + + retval = "%s: %s [api=0x%04x] (%s)\n" % (this.key, this.version, _version.api, this.location) + retval += " - c/c++ dependencies:\n" + for k in sorted(_version.externals): retval += " - %s: %s\n" % (k, _version.externals[k]) + retval += " - python dependencies:\n" + for d in deps: retval += " - %s: %s (%s)\n" % (d.key, d.version, d.location) + + return retval.strip() + +# gets sphinx autodoc done right - don't remove it +__all__ = [_ for _ in dir() if not _.startswith('_')] diff --git a/examples/bob.example.library/bob/example/library/cpp/Function.cpp b/examples/bob.example.library/bob/example/library/cpp/Function.cpp new file mode 100644 index 0000000000000000000000000000000000000000..f88fc84466dff6da644f583d4479d787de29019e --- /dev/null +++ b/examples/bob.example.library/bob/example/library/cpp/Function.cpp @@ -0,0 +1,16 @@ +#include <bob.example.library/Function.h> + +/** + Simple example of a function dealing with a blitz array +*/ + +blitz::Array<double,1> bob::example::library::reverse (const blitz::Array<double,1>& array){ + // create new array in the desired shape + blitz::Array<double,1> retval(array.shape()); + // copy data + for (int i = 0, j = array.extent(0)-1; i < array.extent(0); ++i, --j){ + retval(j) = array(i); + } + // return the copied data + return retval; +} diff --git a/examples/bob.example.library/bob/example/library/include/bob.example.library/Function.h b/examples/bob.example.library/bob/example/library/include/bob.example.library/Function.h new file mode 100644 index 0000000000000000000000000000000000000000..85055e223583bd00be0e34faa150f181b66582f2 --- /dev/null +++ b/examples/bob.example.library/bob/example/library/include/bob.example.library/Function.h @@ -0,0 +1,20 @@ +/** + * @author Manuel Guenther <manuel.guenther@idiap.ch> + * @date Fri Oct 10 12:49:11 CEST 2014 + * + * @brief General directives for all modules in bob.example.library + */ + +#ifndef BOB_EXAMPLE_LIBRARY_FUNCTION_H +#define BOB_EXAMPLE_LIBRARY_FUNCTION_H + +#include <blitz/array.h> + +namespace bob { namespace example { namespace library { + + // Reverses the order of the elements in the given array + blitz::Array<double,1> reverse (const blitz::Array<double,1>& array); + +} } } // namespaces + +# endif // BOB_EXAMPLE_LIBRARY_FUNCTION_H diff --git a/examples/bob.example.library/bob/example/library/include/bob.example.library/config.h b/examples/bob.example.library/bob/example/library/include/bob.example.library/config.h new file mode 100644 index 0000000000000000000000000000000000000000..f8e40633691e69a500615df5d445501c6465304c --- /dev/null +++ b/examples/bob.example.library/bob/example/library/include/bob.example.library/config.h @@ -0,0 +1,14 @@ +/** + * @author Manuel Guenther <manuel.guenther@idiap.ch> + * @date Fri Oct 10 12:49:11 CEST 2014 + * + * @brief General directives for all modules in bob.example.library + */ + +#ifndef BOB_EXAMPLE_LIBRARY_CONFIG_H +#define BOB_EXAMPLE_LIBRARY_H + +/* Macros that define versions and important names */ +#define BOB_EXAMPLE_LIBRARY_API_VERSION 0x0200 + +#endif /* BOB_EXAMPLE_LIBRARY_CONFIG_H */ diff --git a/examples/bob.example.library/bob/example/library/main.cpp b/examples/bob.example.library/bob/example/library/main.cpp new file mode 100644 index 0000000000000000000000000000000000000000..62ecdbb64805bbfd5063589b36ff100cff2aba8d --- /dev/null +++ b/examples/bob.example.library/bob/example/library/main.cpp @@ -0,0 +1,111 @@ +// include directly and indirectly dependent libraries +#ifdef NO_IMPORT_ARRAY +#undef NO_IMPORT_ARRAY +#endif +#include <bob.blitz/cppapi.h> +#include <bob.blitz/cleanup.h> +#include <bob.extension/documentation.h> + +// include our own library +#include <bob.example.library/Function.h> + +// use the documentation classes to document the function +static bob::extension::FunctionDoc reverse_doc = bob::extension::FunctionDoc( + "reverse", + "This is a simple example of bridging between blitz arrays (C++) and numpy.ndarrays (Python)", + "Detailed documentation of the function goes here." +) +.add_prototype("array", "reversed") +.add_parameter("array", "array_like (1D, float)", "The array to reverse") +.add_return("reversed", "array_like (1D, float)", "A copy of the ``array`` with reversed order of entries") +; + +// declare the function +// we use the default Python C-API here. +static PyObject* PyBobExampleLibrary_Reverse(PyObject*, PyObject* args, PyObject* kwargs) { + // declare the expected parameter names + char* kwlist[] = {const_cast<char*>("array"), NULL}; + + // declare an object of the bridging type + PyBlitzArrayObject* array; + // ... and get the command line argument + if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O&", kwlist, &PyBlitzArray_Converter, &array)) return 0; + + // since PyBlitzArray_Converter increased the reference count of array, + // assure that the reference is decreased when the function exits (either way) + auto array_ = make_safe(array); + + // check that the array has the expected properties + if (array->type_num != NPY_FLOAT64 || array->ndim != 1){ + PyErr_Format(PyExc_TypeError, "%s : Only 1D arrays of type float are allowed", reverse_doc.name()); + return 0; + } + + // extract the actual blitz array from the Python type + blitz::Array<double, 1> bz = *PyBlitzArrayCxx_AsBlitz<double, 1>(array); + + // call the C++ function + blitz::Array<double, 1> reversed = bob::example::library::reverse(bz); + + // convert the blitz array back to numpy and return it + return PyBlitzArrayCxx_AsNumpy(reversed); +} + + +////////////////////////////////////////////////////////////////////////// +/////// Python module declaration //////////////////////////////////////// +////////////////////////////////////////////////////////////////////////// + +// module-wide methods +static PyMethodDef module_methods[] = { + { + reverse_doc.name(), + (PyCFunction)PyBobExampleLibrary_Reverse, + METH_VARARGS|METH_KEYWORDS, + reverse_doc.doc() + }, + {NULL} // Sentinel +}; + +// module documentation +PyDoc_STRVAR(module_docstr, "Exemplary Python Bindings"); + +// module definition +#if PY_VERSION_HEX >= 0x03000000 +static PyModuleDef module_definition = { + PyModuleDef_HEAD_INIT, + BOB_EXT_MODULE_NAME, + module_docstr, + -1, + module_methods, + 0, 0, 0, 0 +}; +#endif + +// create the module +static PyObject* create_module (void) { + +# if PY_VERSION_HEX >= 0x03000000 + PyObject* module = PyModule_Create(&module_definition); +# else + PyObject* module = Py_InitModule3(BOB_EXT_MODULE_NAME, module_methods, module_docstr); +# endif + if (!module) return 0; + auto module_ = make_safe(module); ///< protects against early returns + + if (PyModule_AddStringConstant(module, "__version__", BOB_EXT_MODULE_VERSION) < 0) return 0; + + /* imports bob.blitz C-API + dependencies */ + if (import_bob_blitz() < 0) return 0; + + Py_INCREF(module); + return module; + +} + +PyMODINIT_FUNC BOB_EXT_ENTRY_NAME (void) { +# if PY_VERSION_HEX >= 0x03000000 + return +# endif + create_module(); +} diff --git a/examples/bob.example.library/bob/example/library/script/__init__.py b/examples/bob.example.library/bob/example/library/script/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/examples/bob.example.library/bob/example/library/script/reverse.py b/examples/bob.example.library/bob/example/library/script/reverse.py new file mode 100644 index 0000000000000000000000000000000000000000..e1591ebf6c0553f20a3da37ac14e9836fbd6d378 --- /dev/null +++ b/examples/bob.example.library/bob/example/library/script/reverse.py @@ -0,0 +1,37 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Sun 15 Apr 14:01:39 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Inverts the list of floating point numbers given on command line +""" + +from .._library import reverse + +def main(): + """Main routine, called by the script that gets the configuration of bob.blitz""" + + import sys + if len(sys.argv) == 1: + print ("Usage: %s <numbers>\n" % sys.argv[0]) + return + + numbers = [float(n) for n in sys.argv[1:]] + print (numbers) + rev = reverse(numbers) + + print ("%s reversed is %s" % (numbers, rev)) diff --git a/examples/bob.example.library/bob/example/library/script/version.py b/examples/bob.example.library/bob/example/library/script/version.py new file mode 100644 index 0000000000000000000000000000000000000000..827eaafa916468be7bbdc36c611c79bd1ae45e83 --- /dev/null +++ b/examples/bob.example.library/bob/example/library/script/version.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Sun 15 Apr 14:01:39 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Prints the version of bob and exits +""" + +def main(): + """Main routine, called by the script that gets the configuration of bob.blitz""" + + import bob.blitz + print (bob.blitz.get_config()) + diff --git a/examples/bob.example.library/bob/example/library/test.py b/examples/bob.example.library/bob/example/library/test.py new file mode 100644 index 0000000000000000000000000000000000000000..785f3782a384b8e5adb778e887b810391f679e45 --- /dev/null +++ b/examples/bob.example.library/bob/example/library/test.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Wed 15 Aug 09:59:33 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Test Units +""" + +def test_reverse(): + from . import reverse + source = [0., 1., 2., 3., 4.] + target = reverse(source) + for i in range(5): + assert target[i] == source[4-i] + diff --git a/examples/bob.example.library/bob/example/library/version.cpp b/examples/bob.example.library/bob/example/library/version.cpp new file mode 100644 index 0000000000000000000000000000000000000000..e069417e6d7397dd48064408dc114a80d66a9bef --- /dev/null +++ b/examples/bob.example.library/bob/example/library/version.cpp @@ -0,0 +1,160 @@ +/** + * @author Andre Anjos <andre.anjos@idiap.ch> + * @date Thu 7 Nov 13:50:16 2013 + * + * @brief Binds configuration information available from bob + */ + +#ifdef NO_IMPORT_ARRAY +#undef NO_IMPORT_ARRAY +#endif +#include <bob.blitz/capi.h> +#include <bob.blitz/cleanup.h> + +// include our own configuration +#include <bob.example.library/config.h> + +#include <string> +#include <cstdlib> +#include <blitz/blitz.h> +#include <boost/preprocessor/stringize.hpp> +#include <boost/version.hpp> +#include <boost/format.hpp> + + +static int dict_set(PyObject* d, const char* key, const char* value) { + PyObject* v = Py_BuildValue("s", value); + if (!v) return 0; + auto v_ = make_safe(v); + int retval = PyDict_SetItemString(d, key, v); + if (retval == 0) return 1; //all good + return 0; //a problem occurred +} + +static int dict_steal(PyObject* d, const char* key, PyObject* value) { + if (!value) return 0; + auto value_ = make_safe(value); + int retval = PyDict_SetItemString(d, key, value); + if (retval == 0) return 1; //all good + return 0; //a problem occurred +} + +/*********************************************************** + * Version number generation + ***********************************************************/ + +/** + * Describes the compiler version + */ +static PyObject* compiler_version() { +# if defined(__GNUC__) && !defined(__llvm__) + boost::format f("%s.%s.%s"); + f % BOOST_PP_STRINGIZE(__GNUC__); + f % BOOST_PP_STRINGIZE(__GNUC_MINOR__); + f % BOOST_PP_STRINGIZE(__GNUC_PATCHLEVEL__); + return Py_BuildValue("{ssss}", "name", "gcc", "version", f.str().c_str()); +# elif defined(__llvm__) && !defined(__clang__) + return Py_BuildValue("{ssss}", "name", "llvm-gcc", "version", __VERSION__); +# elif defined(__clang__) + return Py_BuildValue("{ssss}", "name", "clang", "version", __clang_version__); +# else + return Py_BuildValue("{ssss}", "name", "unsupported", "version", "unknown"); +# endif +} + +/** + * Python version with which we compiled the extensions + */ +static PyObject* python_version() { + boost::format f("%s.%s.%s"); + f % BOOST_PP_STRINGIZE(PY_MAJOR_VERSION); + f % BOOST_PP_STRINGIZE(PY_MINOR_VERSION); + f % BOOST_PP_STRINGIZE(PY_MICRO_VERSION); + return Py_BuildValue("s", f.str().c_str()); +} + +/** + * Numpy version + */ +static PyObject* numpy_version() { + return Py_BuildValue("{ssss}", "abi", BOOST_PP_STRINGIZE(NPY_VERSION), "api", BOOST_PP_STRINGIZE(NPY_API_VERSION)); +} + +/** + * bob.blitz c/c++ api version + */ +static PyObject* bob_blitz_version() { + return Py_BuildValue("{ss}", "api", BOOST_PP_STRINGIZE(BOB_BLITZ_API_VERSION)); +} + + +// builds the dictionary of versions +static PyObject* build_version_dictionary() { + + PyObject* retval = PyDict_New(); + if (!retval) return 0; + auto retval_ = make_safe(retval); + + if (!dict_steal(retval, "Compiler", compiler_version())) return 0; + if (!dict_steal(retval, "Python", python_version())) return 0; + if (!dict_steal(retval, "NumPy", numpy_version())) return 0; + if (!dict_set(retval, "Blitz++", BZ_VERSION)) return 0; + if (!dict_steal(retval, "bob.blitz", bob_blitz_version())) return 0; + + Py_INCREF(retval); + Py_INCREF(retval); + return retval; +} + +static PyMethodDef module_methods[] = { + {0} /* Sentinel */ +}; + +PyDoc_STRVAR(module_docstr, +"Information about software used to compile the C++ Bob API" +); + +#if PY_VERSION_HEX >= 0x03000000 +static PyModuleDef module_definition = { + PyModuleDef_HEAD_INIT, + BOB_EXT_MODULE_NAME, + module_docstr, + -1, + module_methods, + 0, 0, 0, 0 +}; +#endif + +static PyObject* create_module (void) { + +# if PY_VERSION_HEX >= 0x03000000 + PyObject* m = PyModule_Create(&module_definition); +# else + PyObject* m = Py_InitModule3(BOB_EXT_MODULE_NAME, module_methods, module_docstr); +# endif + if (!m) return 0; + auto m_ = make_safe(m); ///< protects against early returns + + /* register version numbers and constants */ + if (PyModule_AddIntConstant(m, "api", BOB_EXAMPLE_LIBRARY_API_VERSION) < 0) return 0; + if (PyModule_AddStringConstant(m, "module", BOB_EXT_MODULE_VERSION) < 0) return 0; + if (PyModule_AddObject(m, "externals", build_version_dictionary()) < 0) return 0; + + /* imports dependencies */ + if (import_bob_blitz() < 0) { + PyErr_Print(); + PyErr_Format(PyExc_ImportError, "cannot import `%s'", BOB_EXT_MODULE_NAME); + return 0; + } + + Py_INCREF(m); + return m; + +} + +PyMODINIT_FUNC BOB_EXT_ENTRY_NAME (void) { +# if PY_VERSION_HEX >= 0x03000000 + return +# endif + create_module(); +} diff --git a/examples/bob.example.library/bootstrap.py b/examples/bob.example.library/bootstrap.py new file mode 100644 index 0000000000000000000000000000000000000000..2ec152f662355e3288f20f1a80afcdd710cfdea5 --- /dev/null +++ b/examples/bob.example.library/bootstrap.py @@ -0,0 +1,183 @@ +############################################################################## +# +# 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 +import shutil +import sys +import tempfile + +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +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 --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +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", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install setuptools + +to_reload = False +try: + import pkg_resources + import setuptools +except ImportError: + ez = {} + + try: + from urllib.request import urlopen + except ImportError: + from urllib2 import urlopen + + # XXX use a more permanent ez_setup.py URL when available. + exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py' + ).read(), ez) + setup_args = dict(to_dir=tmpeggs, download_delay=0) + ez['use_setuptools'](**setup_args) + + if to_reload: + reload(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) + +###################################################################### +# Try to best guess the version of buildout given setuptools +if options.version is None: + + try: + from distutils.version import LooseVersion + package = pkg_resources.require('setuptools')[0] + v = LooseVersion(package.version) + if v < LooseVersion('0.7'): + options.version = '2.1.1' + except: + pass + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +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=[setuptools_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) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: + raise Exception( + "Failed to execute command:\n%s", + repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff --git a/examples/bob.example.library/buildout.cfg b/examples/bob.example.library/buildout.cfg new file mode 100644 index 0000000000000000000000000000000000000000..ef4cc8f2c5a2c55b8f2df17a417f0fec4389f1d5 --- /dev/null +++ b/examples/bob.example.library/buildout.cfg @@ -0,0 +1,18 @@ +; vim: set fileencoding=utf-8 : +; Manuel Guenther <manuel.guenther@idiap.ch> +; Thu Oct 9 16:51:06 CEST 2014 + +[buildout] +parts = scripts +eggs = bob.example.library +extensions = bob.buildout + +develop = . + +; options for bob.buildout +debug = true +verbose = true +newest = false + +[scripts] +recipe = bob.buildout:scripts diff --git a/examples/bob.example.library/doc/conf.py b/examples/bob.example.library/doc/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..4c21b4366d0f2b013562f9c8f932615daad2543e --- /dev/null +++ b/examples/bob.example.library/doc/conf.py @@ -0,0 +1,253 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 13 Aug 2012 12:38:15 CEST +# +# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +import os +import sys +import glob +import pkg_resources + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.pngmath', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + ] + +# The viewcode extension appeared only on Sphinx >= 1.0.0 +import sphinx +if sphinx.__version__ >= "1.0": + extensions.append('sphinx.ext.viewcode') + +# Always includes todos +todo_include_todos = True + +# If we are on OSX, the 'dvipng' path maybe different +dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng' +if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Bob Example Project' +import time +copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') + +# Grab the setup entry +distribution = pkg_resources.require('bob.example.library')[0] + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = distribution.version +# The full version, including alpha/beta/rc tags. +release = distribution.version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +#exclude_patterns = ['**/links.rst'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +if sphinx.__version__ >= "1.0": + html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = 'bob' + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bob_example_library_doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +latex_paper_size = 'a4' + +# The font size ('10pt', '11pt' or '12pt'). +latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'bob_example_library.tex', u'Bob', + u'Biometrics Group, Idiap Research Institute', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = '' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# Included after all input documents +rst_epilog = '' + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'bob.example.library', u'Bob Example Library Documentation', [u'Idiap Research Institute'], 1) +] + +# Default processing flags for sphinx +autoclass_content = 'both' +autodoc_member_order = 'bysource' +autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance'] + +# For inter-documentation mapping: +from bob.extension.utils import link_documentation +intersphinx_mapping = link_documentation() + + +def setup(app): + pass diff --git a/examples/bob.example.library/doc/index.rst b/examples/bob.example.library/doc/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..d4396b8d3bc423a31a9830fa269d54b1c7e95a2c --- /dev/null +++ b/examples/bob.example.library/doc/index.rst @@ -0,0 +1,15 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Mon 13 Aug 2012 12:36:40 CEST + +===================== + Bob Example Library +===================== + + +Package Documentation +--------------------- + +.. automodule:: bob.example.library + + diff --git a/examples/bob.example.library/requirements.txt b/examples/bob.example.library/requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..0d5737b0d27e716b02c8ce942af53ef20ec8cdfe --- /dev/null +++ b/examples/bob.example.library/requirements.txt @@ -0,0 +1 @@ +bob.blitz diff --git a/examples/bob.example.library/setup.py b/examples/bob.example.library/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..4227c6be25f27b8b0464e8cd77a3012cb9840f80 --- /dev/null +++ b/examples/bob.example.library/setup.py @@ -0,0 +1,182 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 16 Apr 08:18:08 2012 CEST +# +# Copyright (C) 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/>. + +# This file contains the python (distutils/setuptools) instructions so your +# package can be installed on **any** host system. It defines some basic +# information like the package name for instance, or its homepage. +# +# It also defines which other packages this python package depends on and that +# are required for this package's operation. The python subsystem will make +# sure all dependent packages are installed or will install them for you upon +# the installation of this package. +# +# The 'buildout' system we use here will go further and wrap this package in +# such a way to create an isolated python working environment. Buildout will +# make sure that dependencies which are not yet installed do get installed, but +# **without** requiring administrative privileges on the host system. This +# allows you to test your package with new python dependencies w/o requiring +# administrative interventions. + + + +# Add here other bob packages that your module depend on +setup_packages = ['bob.extension', 'bob.blitz'] +bob_packages = [] + +from setuptools import setup, find_packages, dist +dist.Distribution(dict(setup_requires = setup_packages + bob_packages)) + +# import the Extension and Library classes and the build_ext function from bob.blitz +from bob.blitz.extension import Extension, Library, build_ext + +# load the requirements.txt for additional requirements +from bob.extension.utils import load_requirements +build_requires = setup_packages + bob_packages + load_requirements() + +# read version from "version.txt" file +version = open("version.txt").read().rstrip() + + +# The only thing we do in this file is to call the setup() function with all +# parameters that define our package. +setup( + + # This is the basic information about your project. Modify all this + # information before releasing code publicly. + name = 'bob.example.library', + version = version, + description = 'Example for using Bob inside a C++ extension of a buildout project', + + url = 'https://www.github.com/<YourInstitution>/<YourPackage>', + license = 'GPLv3', + author = '<YourName>', + author_email='<YourEmail>', + keywords='bob, extension', + + # If you have a better, long description of your package, place it on the + # 'doc' directory and then hook it here + long_description = open('README.rst').read(), + + # This line is required for any distutils based packaging. + packages = find_packages(), + include_package_data = True, + + # These lines define which packages should be installed when you "install" + # this package. All packages that are mentioned here, but are not installed + # on the current system will be installed locally and only visible to the + # scripts of this package. Don't worry - You won't need administrative + # privileges when using buildout. + setup_requires = build_requires, + install_requires = build_requires, + + # Your project should be called something like 'bob.<foo>' or + # 'bob.<foo>.<bar>'. To implement this correctly and still get all your + # packages to be imported w/o problems, you need to implement namespaces + # on the various levels of the package and declare them here. See more + # about this here: + # http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages + # + # Our database packages are good examples of namespace implementations + # using several layers. You can check them out here: + # https://github.com/idiap/bob/wiki/Satellite-Packages + namespace_packages = [ + 'bob', + 'bob.example', + ], + + # In fact, we are defining two extensions here. In any case, you can define + # as many extensions as you need. Each of them will be compiled + # independently into a separate .so file. + ext_modules = [ + + # The first extension defines the version of this package and all C++-dependencies. + Extension("bob.example.library.version", + # list of files compiled into this extension + [ + "bob/example/library/version.cpp", + ], + # additional parameters, see Extension documentation + version = version, + bob_packages = bob_packages, + ), + + Library("bob.example.library.bob_example_library", + # list of pure C/C++ files compiled into this library + [ + "bob/example/library/cpp/Function.cpp", + ], + # additional parameters, see Library documentation + version = version, + bob_packages = bob_packages, + ), + + # The second extension contains the actual C++ code and the Python bindings + Extension("bob.example.library._library", + # list of files compiled into this extension + [ + # the Python bindings + "bob/example/library/main.cpp", + ], + # additional parameters, see Extension documentation + version = version, + bob_packages = bob_packages, + ), + ], + + # Important! We need to tell setuptools that we want the extension to be + # compiled with our build_ext function! + cmdclass = { + 'build_ext': build_ext, + }, + + # This entry defines which scripts you will have inside the 'bin' directory + # once you install the package (or run 'bin/buildout'). The order of each + # entry under 'console_scripts' is like this: + # script-name-at-bin-directory = module.at.your.library:function + # + # The module.at.your.library is the python file within your library, using + # the python syntax for directories (i.e., a '.' instead of '/' or '\'). + # This syntax also omits the '.py' extension of the filename. So, a file + # installed under 'example/foo.py' that contains a function which + # implements the 'main()' function of particular script you want to have + # should be referred as 'example.foo:main'. + # + # In this simple example we will create a single program that will print + # the version of bob. + entry_points = { + + # scripts should be declared using this entry: + 'console_scripts': [ + 'reverse.py = bob.example.library.script.reverse:main', + ], + }, + + # Classifiers are important if you plan to distribute this package through + # PyPI. You can find the complete list of classifiers that are valid and + # useful here (http://pypi.python.org/pypi?%3Aaction=list_classifiers). + classifiers = [ + 'Framework :: Bob', + 'Development Status :: 4 - Beta', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'Natural Language :: English', + 'Programming Language :: Python', + 'Topic :: Scientific/Engineering :: Artificial Intelligence', + ], +) diff --git a/examples/bob.example.library/version.txt b/examples/bob.example.library/version.txt new file mode 100644 index 0000000000000000000000000000000000000000..8ea4f48f6ca5b5149a254c16b97801cb338d7011 --- /dev/null +++ b/examples/bob.example.library/version.txt @@ -0,0 +1 @@ +0.0.1a0 diff --git a/examples/bob.example.project/.gitignore b/examples/bob.example.project/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..b8afedd4fabe76662e1ef277c0a7b285fc0ff256 --- /dev/null +++ b/examples/bob.example.project/.gitignore @@ -0,0 +1,13 @@ +*~ +*.swp +*.pyc +bin +eggs +parts +.installed.cfg +.mr.developer.cfg +*.egg-info +src +develop-eggs +sphinx +dist diff --git a/examples/bob.example.project/COPYING b/examples/bob.example.project/COPYING new file mode 100644 index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2 --- /dev/null +++ b/examples/bob.example.project/COPYING @@ -0,0 +1,674 @@ + 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>. diff --git a/examples/bob.example.project/MANIFEST.in b/examples/bob.example.project/MANIFEST.in new file mode 100644 index 0000000000000000000000000000000000000000..fd1b94181fc5ddf829f4bcc7b212b673e5b8ae92 --- /dev/null +++ b/examples/bob.example.project/MANIFEST.in @@ -0,0 +1,2 @@ +include README.rst bootstrap.py buildout.cfg COPYING version.txt +recursive-include doc *.py *.rst diff --git a/examples/bob.example.project/README.rst b/examples/bob.example.project/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..4be01aeb69276e8a8623cfded4f7b8a535dcafcb --- /dev/null +++ b/examples/bob.example.project/README.rst @@ -0,0 +1,28 @@ +Example buildout environment +============================ + +This simple example demonstrates how to wrap Bob-based scripts on buildout +environments. This may be useful for homework assignments, tests or as a way to +distribute code to reproduce your publication. In summary, if you need to give +out code to others, we recommend you do it following this template so your code +can be tested, documented and run in an orderly fashion. + +Installation +------------ + +.. note:: + + To follow these instructions locally you will need a local copy of this + package. For that, you can use the github tarball API to download the package:: + + $ wget --no-check-certificate https://github.com/idiap/bob.project.example/tarball/master -O- | tar xz + $ mv idiap-bob.project* bob.project.example + +Documentation and Further Information +------------------------------------- + +Please refer to the latest Bob user guide, accessing from the `Bob website +<http://idiap.github.com/bob/>`_ for how to create your own packages based on +this example. In particular, the Section entitled `Organize Your Work in +Satellite Packages <http://www.idiap.ch/software/bob/docs/releases/last/sphinx/html/OrganizeYourCode.html>`_ +contains details on how to setup, build and roll out your code. diff --git a/examples/bob.example.project/bob/__init__.py b/examples/bob.example.project/bob/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.project/bob/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.project/bob/example/__init__.py b/examples/bob.example.project/bob/example/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..60381ea9b78a067c402bf65368cc63241b0d7456 --- /dev/null +++ b/examples/bob.example.project/bob/example/__init__.py @@ -0,0 +1,2 @@ +#see http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages +__import__('pkg_resources').declare_namespace(__name__) diff --git a/examples/bob.example.project/bob/example/project/__init__.py b/examples/bob.example.project/bob/example/project/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..47bf1edaf9876a86fe7d5ceee638d1bd324b0ec0 --- /dev/null +++ b/examples/bob.example.project/bob/example/project/__init__.py @@ -0,0 +1,20 @@ +from . import script + +def get_config(): + """Returns a string containing the configuration information. + """ + + import pkg_resources + + packages = pkg_resources.require(__name__) + this = packages[0] + deps = packages[1:] + + retval = "%s: %s (%s)\n" % (this.key, this.version, this.location) + retval += " - python dependencies:\n" + for d in deps: retval += " - %s: %s (%s)\n" % (d.key, d.version, d.location) + + return retval.strip() + +# gets sphinx autodoc done right - don't remove it +__all__ = [_ for _ in dir() if not _.startswith('_')] diff --git a/examples/bob.example.project/bob/example/project/script/__init__.py b/examples/bob.example.project/bob/example/project/script/__init__.py new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/examples/bob.example.project/bob/example/project/script/version.py b/examples/bob.example.project/bob/example/project/script/version.py new file mode 100644 index 0000000000000000000000000000000000000000..827eaafa916468be7bbdc36c611c79bd1ae45e83 --- /dev/null +++ b/examples/bob.example.project/bob/example/project/script/version.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Sun 15 Apr 14:01:39 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Prints the version of bob and exits +""" + +def main(): + """Main routine, called by the script that gets the configuration of bob.blitz""" + + import bob.blitz + print (bob.blitz.get_config()) + diff --git a/examples/bob.example.project/bob/example/project/test.py b/examples/bob.example.project/bob/example/project/test.py new file mode 100644 index 0000000000000000000000000000000000000000..06c6e41398791f93d7a09ac70867b06c7482debf --- /dev/null +++ b/examples/bob.example.project/bob/example/project/test.py @@ -0,0 +1,29 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.dos.anjos@gmail.com> +# Wed 15 Aug 09:59:33 2012 +# +# Copyright (C) 2011-2013 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/>. + +"""Test Units +""" + +import unittest + +class MyTests(unittest.TestCase): + + def test_version(self): + from .script import version + self.assertEqual(version.main(), 0) diff --git a/examples/bob.example.project/bootstrap.py b/examples/bob.example.project/bootstrap.py new file mode 100644 index 0000000000000000000000000000000000000000..2ec152f662355e3288f20f1a80afcdd710cfdea5 --- /dev/null +++ b/examples/bob.example.project/bootstrap.py @@ -0,0 +1,183 @@ +############################################################################## +# +# 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 +import shutil +import sys +import tempfile + +from optparse import OptionParser + +tmpeggs = tempfile.mkdtemp() + +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 --find-links to point to local resources, you can keep +this script from going over the network. +''' + +parser = OptionParser(usage=usage) +parser.add_option("-v", "--version", help="use a specific zc.buildout version") + +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", "--config-file", + help=("Specify the path to the buildout configuration " + "file to be used.")) +parser.add_option("-f", "--find-links", + help=("Specify a URL to search for buildout releases")) + + +options, args = parser.parse_args() + +###################################################################### +# load/install setuptools + +to_reload = False +try: + import pkg_resources + import setuptools +except ImportError: + ez = {} + + try: + from urllib.request import urlopen + except ImportError: + from urllib2 import urlopen + + # XXX use a more permanent ez_setup.py URL when available. + exec(urlopen('https://bitbucket.org/pypa/setuptools/raw/0.7.2/ez_setup.py' + ).read(), ez) + setup_args = dict(to_dir=tmpeggs, download_delay=0) + ez['use_setuptools'](**setup_args) + + if to_reload: + reload(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) + +###################################################################### +# Try to best guess the version of buildout given setuptools +if options.version is None: + + try: + from distutils.version import LooseVersion + package = pkg_resources.require('setuptools')[0] + v = LooseVersion(package.version) + if v < LooseVersion('0.7'): + options.version = '2.1.1' + except: + pass + +###################################################################### +# Install buildout + +ws = pkg_resources.working_set + +cmd = [sys.executable, '-c', + 'from setuptools.command.easy_install import main; main()', + '-mZqNxd', tmpeggs] + +find_links = os.environ.get( + 'bootstrap-testing-find-links', + options.find_links or + ('http://downloads.buildout.org/' + if options.accept_buildout_test_releases else None) + ) +if find_links: + cmd.extend(['-f', find_links]) + +setuptools_path = ws.find( + pkg_resources.Requirement.parse('setuptools')).location + +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=[setuptools_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) + +import subprocess +if subprocess.call(cmd, env=dict(os.environ, PYTHONPATH=setuptools_path)) != 0: + raise Exception( + "Failed to execute command:\n%s", + repr(cmd)[1:-1]) + +###################################################################### +# Import and run buildout + +ws.add_entry(tmpeggs) +ws.require(requirement) +import zc.buildout.buildout + +if not [a for a in args if '=' not in a]: + args.append('bootstrap') + +# if -c was provided, we push it back into args for buildout' main function +if options.config_file is not None: + args[0:0] = ['-c', options.config_file] + +zc.buildout.buildout.main(args) +shutil.rmtree(tmpeggs) diff --git a/examples/bob.example.project/buildout.cfg b/examples/bob.example.project/buildout.cfg new file mode 100644 index 0000000000000000000000000000000000000000..f14255c39e939b6ae2748f690146e6111c6c8c9f --- /dev/null +++ b/examples/bob.example.project/buildout.cfg @@ -0,0 +1,18 @@ +; vim: set fileencoding=utf-8 : +; Manuel Guenther <manuel.guenther@idiap.ch> +; Thu Oct 9 16:51:06 CEST 2014 + +[buildout] +parts = scripts +eggs = bob.example.project +extensions = bob.buildout + +develop = . + +; options for bob.buildout +debug = true +verbose = true +newest = false + +[scripts] +recipe = bob.buildout:scripts diff --git a/examples/bob.example.project/doc/conf.py b/examples/bob.example.project/doc/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..7b1888c55b16afe352dcd9c3f558e119a2321a10 --- /dev/null +++ b/examples/bob.example.project/doc/conf.py @@ -0,0 +1,253 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 13 Aug 2012 12:38:15 CEST +# +# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland + +import os +import sys +import glob +import pkg_resources + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [ + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.pngmath', + 'sphinx.ext.ifconfig', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + ] + +# The viewcode extension appeared only on Sphinx >= 1.0.0 +import sphinx +if sphinx.__version__ >= "1.0": + extensions.append('sphinx.ext.viewcode') + +# Always includes todos +todo_include_todos = True + +# If we are on OSX, the 'dvipng' path maybe different +dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng' +if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Bob Example Project' +import time +copyright = u'%s, Idiap Research Institute' % time.strftime('%Y') + +# Grab the setup entry +distribution = pkg_resources.require('bob.example.project')[0] + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = distribution.version +# The full version, including alpha/beta/rc tags. +release = distribution.version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +#exclude_patterns = ['**/links.rst'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +if sphinx.__version__ >= "1.0": + html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# "<project> v<release> documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = 'bob' + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'bob_example_project_doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +latex_paper_size = 'a4' + +# The font size ('10pt', '11pt' or '12pt'). +latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'bob_example_project.tex', u'Bob', + u'Biometrics Group, Idiap Research Institute', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +latex_logo = '' + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# Included after all input documents +rst_epilog = '' + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'bob.example.project', u'Bob Example Project Documentation', [u'Idiap Research Institute'], 1) +] + +# Default processing flags for sphinx +autoclass_content = 'both' +autodoc_member_order = 'bysource' +autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance'] + +# For inter-documentation mapping: +from bob.extension.utils import link_documentation +intersphinx_mapping = link_documentation() + + +def setup(app): + pass diff --git a/examples/bob.example.project/doc/index.rst b/examples/bob.example.project/doc/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..2193d6e83de9c457694f51801d1d68b0cc587d8c --- /dev/null +++ b/examples/bob.example.project/doc/index.rst @@ -0,0 +1,19 @@ +.. vim: set fileencoding=utf-8 : +.. Andre Anjos <andre.anjos@idiap.ch> +.. Mon 13 Aug 2012 12:36:40 CEST + +===================== + Bob Example Project +===================== + + +Package Documentation +--------------------- + +.. automodule:: bob.example.project + + +Script Documentation +-------------------- + +.. automodule:: bob.example.project.script diff --git a/examples/bob.example.project/setup.py b/examples/bob.example.project/setup.py new file mode 100644 index 0000000000000000000000000000000000000000..627407e04d83bb93570be467e176966aad3a8d3e --- /dev/null +++ b/examples/bob.example.project/setup.py @@ -0,0 +1,121 @@ +#!/usr/bin/env python +# vim: set fileencoding=utf-8 : +# Andre Anjos <andre.anjos@idiap.ch> +# Mon 16 Apr 08:18:08 2012 CEST +# +# Copyright (C) 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/>. + +# This file contains the python (distutils/setuptools) instructions so your +# package can be installed on **any** host system. It defines some basic +# information like the package name for instance, or its homepage. +# +# It also defines which other packages this python package depends on and that +# are required for this package's operation. The python subsystem will make +# sure all dependent packages are installed or will install them for you upon +# the installation of this package. +# +# The 'buildout' system we use here will go further and wrap this package in +# such a way to create an isolated python working environment. Buildout will +# make sure that dependencies which are not yet installed do get installed, but +# **without** requiring administrative privileges on the host system. This +# allows you to test your package with new python dependencies w/o requiring +# administrative interventions. + +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( + + # This is the basic information about your project. Modify all this + # information before releasing code publicly. + name = 'bob.example.project', + version = open("version.txt").read().rstrip(), + description = 'Example for using Bob inside a buildout project', + + url = 'https://www.github.com/<YourInstitution>/<YourPackage>', + license = 'GPLv3', + author = '<YourName>', + author_email = '<YourEmail>', + keywords = 'bob', + + # If you have a better, long description of your package, place it on the + # 'doc' directory and then hook it here + long_description = open('README.rst').read(), + + # This line is required for any distutils based packaging. + packages = find_packages(), + include_package_data = True, + + # This line defines which packages should be installed when you "install" + # this package. All packages that are mentioned here, but are not installed + # on the current system will be installed locally and only visible to the + # scripts of this package. Don't worry - You won't need administrative + # privileges when using buildout. + install_requires = [ + 'setuptools', + 'bob.blitz' + ], + + # Your project should be called something like 'bob.<foo>' or + # 'bob.<foo>.<bar>'. To implement this correctly and still get all your + # packages to be imported w/o problems, you need to implement namespaces + # on the various levels of the package and declare them here. See more + # about this here: + # http://peak.telecommunity.com/DevCenter/setuptools#namespace-packages + # + # Our database packages are good examples of namespace implementations + # using several layers. You can check them out here: + # https://github.com/idiap/bob/wiki/Satellite-Packages + namespace_packages = [ + 'bob', + 'bob.example', + ], + + # This entry defines which scripts you will have inside the 'bin' directory + # once you install the package (or run 'bin/buildout'). The order of each + # entry under 'console_scripts' is like this: + # script-name-at-bin-directory = module.at.your.library:function + # + # The module.at.your.library is the python file within your library, using + # the python syntax for directories (i.e., a '.' instead of '/' or '\'). + # This syntax also omits the '.py' extension of the filename. So, a file + # installed under 'example/foo.py' that contains a function which + # implements the 'main()' function of particular script you want to have + # should be referred as 'example.foo:main'. + # + # In this simple example we will create a single program that will print + # the version of bob. + entry_points = { + + # scripts should be declared using this entry: + 'console_scripts' : [ + 'version.py = bob.example.project.script.version:main', + ], + }, + + # Classifiers are important if you plan to distribute this package through + # PyPI. You can find the complete list of classifiers that are valid and + # useful here (http://pypi.python.org/pypi?%3Aaction=list_classifiers). + classifiers = [ + 'Framework :: Bob', + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', + 'Natural Language :: English', + 'Programming Language :: Python', + 'Topic :: Scientific/Engineering :: Artificial Intelligence', + ], +) diff --git a/examples/bob.example.project/version.txt b/examples/bob.example.project/version.txt new file mode 100644 index 0000000000000000000000000000000000000000..8ea4f48f6ca5b5149a254c16b97801cb338d7011 --- /dev/null +++ b/examples/bob.example.project/version.txt @@ -0,0 +1 @@ +0.0.1a0