diff --git a/MANIFEST.in b/MANIFEST.in
index 86a6e92e6367dcbcbd23ffcb6bf16d132ec1d73a..64a24146322e9c0e5a7bc873132dc1eb99bbc583 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,3 +1,4 @@
include LICENSE README.rst buildout.cfg version.txt
-recursive-include doc conf.py *.rst *.sh
+recursive-include doc conf.py *.rst *.sh *.png *.ico
recursive-include bob/devtools/data *.md *.yaml *.pem matplotlibrc
+recursive-include bob/devtools/templates conf.py *.rst *.png *.ico LICENSE COPYING .gitlab-ci.yml .gitignore *.cfg *.txt *.py
diff --git a/bob/devtools/scripts/new.py b/bob/devtools/scripts/new.py
new file mode 100644
index 0000000000000000000000000000000000000000..c6f7b8e2097c4d78823b5fd39248ea8b294e6cc5
--- /dev/null
+++ b/bob/devtools/scripts/new.py
@@ -0,0 +1,180 @@
+#!/usr/bin/env python
+
+import os
+import shutil
+import logging
+import datetime
+logger = logging.getLogger(__name__)
+
+import click
+import jinja2
+import pkg_resources
+
+from . import bdt
+from ..log import verbosity_option
+
+
+def copy_file(template, output_dir):
+ '''Copies a file from the template directory to the output directory
+
+ Args:
+
+ template: The path to the template, from the internal templates directory
+ output_dir: Where to save the output
+ '''
+
+ template_file = pkg_resources.resource_filename(__name__, os.path.join('..',
+ 'templates', template))
+ output_file = os.path.join(output_dir, template)
+
+ basedir = os.path.dirname(output_file)
+ if not os.path.exists(basedir):
+ logger.info('mkdir %s', basedir)
+ os.makedirs(basedir)
+
+ logger.info('cp -a %s %s', template_file, output_file)
+ shutil.copy2(template_file, output_file)
+
+
+def render_template(jenv, template, context, output_dir):
+ '''Renders a template to the output directory using specific context
+
+ Args:
+
+ jenv: The Jinja2 environment to use for rendering the template
+ template: The path to the template, from the internal templates directory
+ context: A dictionary with the context to render the template with
+ output_dir: Where to save the output
+ '''
+
+ output_file = os.path.join(output_dir, template)
+
+ basedir = os.path.dirname(output_file)
+ if not os.path.exists(basedir):
+ logger.info('mkdir %s', basedir)
+ os.makedirs(basedir)
+
+ with open(output_file, 'wt') as f:
+ logger.info('rendering %s', output_file)
+ T = jenv.get_template(template)
+ f.write(T.render(**context))
+
+
+@click.command(epilog='''
+Examples:
+
+ 1. Generates a new project for Bob:
+
+ $ bdt new -vv bob/bob.newpackage "John Doe" "joe@example.com"
+''')
+@click.argument('package')
+@click.argument('author')
+@click.argument('email')
+@click.option('-t', '--title', show_default=True,
+ default='New package', help='This entry defines the package title. ' \
+ 'The package title should be a few words only. It will appear ' \
+ 'at the description of your package and as the title of your ' \
+ 'documentation')
+@click.option('-l', '--license', type=click.Choice(['bsd', 'gplv3']),
+ default='gplv3', show_default=True,
+ help='Changes the default licensing scheme to use for your package')
+@click.option('-o', '--output-dir', help='Directory where to dump the new ' \
+ 'project - must not exist')
+@verbosity_option()
+@bdt.raise_on_error
+def new(package, author, email, title, license, output_dir):
+ """Creates a folder structure for a new Bob/BEAT package
+ """
+
+ if '/' not in package:
+ raise RuntimeError('PACKAGE should be specified as "group/name"')
+
+ group, name = package.split('/')
+
+ # creates the rst title, which looks like this:
+ # =======
+ # Title
+ # =======
+ rst_title = ('=' * (2+len(title))) + '\n ' + title + '\n' + \
+ ('=' * (2+len(title)))
+
+ # the jinja context defines the substitutions to be performed
+ today = datetime.datetime.today()
+ context = dict(
+ package = package,
+ group = group,
+ name = name,
+ author = author,
+ email = email,
+ title = title,
+ rst_title = rst_title,
+ license = license,
+ year = today.strftime('%Y'),
+ date = today.strftime('%c'),
+ )
+
+ # copy the whole template structure and de-templatize the needed files
+ if output_dir is None:
+ output_dir = os.path.join(os.path.realpath(os.curdir), name)
+ logger.info('Creating structure for %s at directory %s', package,
+ output_dir)
+
+ if os.path.exists(output_dir):
+ raise IOError('The package directory %s already exists - cannot '
+ 'overwrite!' % output_dir)
+
+ logger.info('mkdir %s', output_dir)
+ os.makedirs(output_dir)
+
+ # base jinja2 engine
+ env = jinja2.Environment(
+ loader=jinja2.PackageLoader('bob.devtools', 'templates'),
+ autoescape=jinja2.select_autoescape(['html', 'xml'])
+ )
+
+ # other standard files
+ simple = [
+ 'requirements.txt',
+ 'buildout.cfg',
+ 'MANIFEST.in',
+ 'setup.py',
+ '.gitignore',
+ 'doc/index.rst',
+ 'doc/conf.py',
+ 'doc/links.rst',
+ '.gitlab-ci.yml',
+ 'README.rst',
+ 'version.txt',
+ ]
+ for k in simple:
+ render_template(env, k, context, output_dir)
+
+ # handles the license file
+ if license == 'gplv3':
+ render_template(env, 'COPYING', context, output_dir)
+ else:
+ render_template(env, 'LICENSE', context, output_dir)
+
+ # creates the base python module structure
+ template_dir = pkg_resources.resource_filename(__name__, os.path.join('..',
+ 'templates'))
+ logger.info('Creating base %s python module', group)
+ shutil.copytree(os.path.join(template_dir, 'pkg'),
+ os.path.join(output_dir, group))
+
+ # copies specific images to the right spot
+ copy_file(os.path.join('doc', 'img', '%s-favicon.ico' % group), output_dir)
+ copy_file(os.path.join('doc', 'img', '%s-128x128.png' % group), output_dir)
+ copy_file(os.path.join('doc', 'img', '%s-logo.png' % group), output_dir)
+
+ # finally, render the conda recipe template-template!
+ # this one is special since it is already a jinja2 template
+ conda_env = jinja2.Environment(
+ loader=jinja2.PackageLoader('bob.devtools', 'templates'),
+ autoescape=jinja2.select_autoescape(['html', 'xml']),
+ block_start_string='(%', block_end_string='%)',
+ variable_start_string='((', variable_end_string='))',
+ comment_start_string='(#', comment_end_string='#)',
+ )
+ render_template(conda_env, os.path.join('conda', 'meta.yaml'), context,
+ output_dir)
diff --git a/bob/devtools/templates/.gitignore b/bob/devtools/templates/.gitignore
new file mode 100644
index 0000000000000000000000000000000000000000..424ce24065ecb84578be159006c3ccc7235dc081
--- /dev/null
+++ b/bob/devtools/templates/.gitignore
@@ -0,0 +1,20 @@
+*~
+*.swp
+*.pyc
+bin
+eggs
+parts
+.installed.cfg
+.mr.developer.cfg
+*.egg-info
+src
+develop-eggs
+sphinx
+dist
+.nfs*
+.gdb_history
+build
+.coverage
+record.txt
+miniconda.sh
+miniconda/
diff --git a/bob/devtools/templates/.gitlab-ci.yml b/bob/devtools/templates/.gitlab-ci.yml
new file mode 100644
index 0000000000000000000000000000000000000000..845b719f2378d396a8b75296a68d1e32c840e7c7
--- /dev/null
+++ b/bob/devtools/templates/.gitlab-ci.yml
@@ -0,0 +1 @@
+include: 'https://gitlab.idiap.ch/bob/bob.devtools/raw/master/bob/devtools/data/gitlab-ci/single-package.yaml'
diff --git a/bob/devtools/templates/COPYING b/bob/devtools/templates/COPYING
new file mode 100644
index 0000000000000000000000000000000000000000..94a9ed024d3859793618152ea559a168bbcbb5e2
--- /dev/null
+++ b/bob/devtools/templates/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/bob/devtools/templates/LICENSE b/bob/devtools/templates/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..b0de7349bee225693be75704037edfcafc147c4a
--- /dev/null
+++ b/bob/devtools/templates/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) {{ year }} Idiap Research Institute, http://www.idiap.ch/
+Written by {{ author }} <{{ email }}>
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/bob/devtools/templates/MANIFEST.in b/bob/devtools/templates/MANIFEST.in
new file mode 100644
index 0000000000000000000000000000000000000000..fac97cf2439f857fee27bffc837152366d61c2e1
--- /dev/null
+++ b/bob/devtools/templates/MANIFEST.in
@@ -0,0 +1,2 @@
+include README.rst buildout.cfg {% if license.startswith('gpl') %}COPYING {% endif %}version.txt requirements.txt
+recursive-include doc *.rst *.png *.ico *.txt
diff --git a/bob/devtools/templates/README.rst b/bob/devtools/templates/README.rst
new file mode 100644
index 0000000000000000000000000000000000000000..466e50a3f65c7ee73f40e8f8eff784581c508e3b
--- /dev/null
+++ b/bob/devtools/templates/README.rst
@@ -0,0 +1,46 @@
+.. -*- coding: utf-8 -*-
+
+.. image:: https://img.shields.io/badge/docs-stable-yellow.svg
+ :target: https://www.idiap.ch/software/bob/docs/{{ package }}/stable/index.html
+.. image:: https://img.shields.io/badge/docs-latest-orange.svg
+ :target: https://www.idiap.ch/software/bob/docs/{{ package }}/master/index.html
+.. image:: https://gitlab.idiap.ch/{{ package }}/badges/master/build.svg
+ :target: https://gitlab.idiap.ch/{{ package }}/commits/master
+.. image:: https://gitlab.idiap.ch/{{ package }}/badges/master/coverage.svg
+ :target: https://gitlab.idiap.ch/{{ package }}/commits/master
+.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg
+ :target: https://gitlab.idiap.ch/{{ package }}
+.. image:: https://img.shields.io/pypi/v/{{ name }}.svg
+ :target: https://pypi.python.org/pypi/{{ name }}
+
+
+{{ rst_title }}
+
+This package is part of {% if group == "bob" %}the signal-processing and machine learning toolbox Bob_{% else %}BEAT_, an open-source evaluation platform for data science algorithms and workflows{% endif %}.
+
+.. todo::
+
+ **Complete the sentence above to include one phrase about your
+ package! Once this is done, delete this to-do!**
+
+
+Installation
+------------
+
+Complete {{ group }}'s `installation`_ instructions. Then, to install this
+package, run::
+
+ $ conda install {{ name }}
+
+
+Contact
+-------
+
+For questions or reporting issues to this software package, contact our
+development `mailing list`_.
+
+
+.. Place your references here:
+.. _{{ group }}: https://www.idiap.ch/software/{{ group }}
+.. _installation: https://www.idiap.ch/software/{{ group }}/install
+.. _mailing list: https://www.idiap.ch/software/{{ group }}/discuss
diff --git a/bob/devtools/templates/buildout.cfg b/bob/devtools/templates/buildout.cfg
new file mode 100644
index 0000000000000000000000000000000000000000..de25db7db4159bcb20b316ba90975eb9ad606eaf
--- /dev/null
+++ b/bob/devtools/templates/buildout.cfg
@@ -0,0 +1,14 @@
+; -*- coding: utf-8 -*-
+; {{ date }}
+
+[buildout]
+parts = scripts
+develop = .
+eggs = {{ name }}
+extensions = bob.buildout
+newest = false
+verbose = true
+
+[scripts]
+recipe = bob.buildout:scripts
+dependent-scripts = true
diff --git a/bob/devtools/templates/conda/meta.yaml b/bob/devtools/templates/conda/meta.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..4fd8b9e99c993ba93e885fec13b772b354ff5b3e
--- /dev/null
+++ b/bob/devtools/templates/conda/meta.yaml
@@ -0,0 +1,52 @@
+{% set name = '(( name ))' %}
+{% set project_dir = environ.get('RECIPE_DIR') + '/..' %}
+
+package:
+ name: {{ name }}
+ version: {{ environ.get('BOB_PACKAGE_VERSION', '0.0.1') }}
+
+build:
+ number: {{ environ.get('BOB_BUILD_NUMBER', 0) }}
+ run_exports:
+ - {{ pin_subpackage(name) }}
+ script:
+ - cd {{ project_dir }}
+ {% if environ.get('BUILD_EGG') %}
+ - python setup.py sdist --formats=zip
+ {% endif %}
+ - python setup.py install --single-version-externally-managed --record record.txt
+
+requirements:
+ # place your build dependencies before the 'host' section
+ host:
+ - python {{ python }}
+ - setuptools {{ setuptools }}
+ # place your other host dependencies here
+ run:
+ - python
+ - setuptools
+ # place other runtime dependencies here (same as requirements.txt)
+
+test:
+ imports:
+ - {{ name }}
+ commands:
+ # test commands ("script" entry-points) from your package here
+ - nosetests --with-coverage --cover-package={{ name }} -sv {{ name }}
+ - sphinx-build -aEW {{ project_dir }}/doc {{ project_dir }}/sphinx
+ - sphinx-build -aEb doctest {{ project_dir }}/doc sphinx
+ - conda inspect linkages -p $PREFIX {{ name }} # [not win]
+ - conda inspect objects -p $PREFIX {{ name }} # [osx]
+ requires:
+ - bob-devel {{ bob_devel }}.*
+ - nose
+ - coverage
+ - sphinx
+ - sphinx_rtd_theme
+ # extend this list with further test-time-only dependencies
+
+about:
+ home: https://www.idiap.ch/software/bob/
+ license: (% if license == 'gplv3' %)GNU General Public License v3 (GPLv3)(% else %)BSD 3-Clause(% endif %)
+ license_family: (% if license == 'gplv3' %)GPL(% else %)BSD(% endif %)
+ summary: (( title ))
diff --git a/bob/devtools/templates/doc/.DS_Store b/bob/devtools/templates/doc/.DS_Store
new file mode 100644
index 0000000000000000000000000000000000000000..940e942902c4c95c53cc11d73aa9ce43019c31f2
Binary files /dev/null and b/bob/devtools/templates/doc/.DS_Store differ
diff --git a/bob/devtools/templates/doc/conf.py b/bob/devtools/templates/doc/conf.py
new file mode 100644
index 0000000000000000000000000000000000000000..62015937e82c17c833b8900117ca433bd3067db3
--- /dev/null
+++ b/bob/devtools/templates/doc/conf.py
@@ -0,0 +1,254 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+import os
+import pkg_resources
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+needs_sphinx = '1.3'
+
+# 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.ifconfig',
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.autosummary',
+ 'sphinx.ext.doctest',
+ 'sphinx.ext.graphviz',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.napoleon',
+ 'sphinx.ext.viewcode',
+ 'sphinx.ext.mathjax',
+ #'matplotlib.sphinxext.plot_directive'
+]
+
+# Be picky about warnings
+nitpicky = False
+
+# Ignores stuff we can't easily resolve on other project's sphinx manuals
+nitpick_ignore = []
+
+# Allows the user to override warnings from a separate file
+if os.path.exists('nitpick-exceptions.txt'):
+ for line in open('nitpick-exceptions.txt'):
+ if line.strip() == "" or line.startswith("#"):
+ continue
+ dtype, target = line.split(None, 1)
+ target = target.strip()
+ nitpick_ignore.append((dtype, target))
+
+# Always includes todos
+todo_include_todos = True
+
+# Generates auto-summary automatically
+autosummary_generate = True
+
+# Create numbers on figures with captions
+numfig = True
+
+# If we are on OSX, the 'dvipng' path maybe different
+dvipng_osx = '/Library/TeX/texbin/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'{{ name }}'
+import time
+copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
+
+# Grab the setup entry
+distribution = pkg_resources.require(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 = []
+
+# Some variables which are useful for generated material
+project_variable = project.replace('.', '_')
+short_description = u'{{ title }}'
+owner = [u'Idiap Research Institute']
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+import sphinx_rtd_theme
+html_theme = 'sphinx_rtd_theme'
+
+# 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 = [sphinx_rtd_theme.get_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 = project_variable
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+html_logo = 'img/{{ group }}-logo.png'
+
+# 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 = 'img/{{ group }}-favicon.ico'
+
+# 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 = project_variable + u'_doc'
+
+# -- Post configuration --------------------------------------------------------
+
+# Included after all input documents
+rst_epilog = """
+.. |project| replace:: Bob
+.. |version| replace:: %s
+.. |current-year| date:: %%Y
+""" % (version, )
+
+# Default processing flags for sphinx
+autoclass_content = 'class'
+autodoc_member_order = 'bysource'
+autodoc_default_flags = [
+ 'members',
+ 'undoc-members',
+ 'show-inheritance',
+]
+
+# For inter-documentation mapping:
+from bob.extension.utils import link_documentation, load_requirements
+sphinx_requirements = "extra-intersphinx.txt"
+if os.path.exists(sphinx_requirements):
+ intersphinx_mapping = link_documentation(
+ additional_packages=['python', 'numpy'] +
+ load_requirements(sphinx_requirements))
+else:
+ intersphinx_mapping = link_documentation()
+
+# We want to remove all private (i.e. _. or __.__) members
+# that are not in the list of accepted functions
+accepted_private_functions = ['__array__']
+
+
+def member_function_test(app, what, name, obj, skip, options):
+ # test if we have a private function
+ if len(name) > 1 and name[0] == '_':
+ # test if this private function should be allowed
+ if name not in accepted_private_functions:
+ # omit privat functions that are not in the list of accepted private functions
+ return skip
+ else:
+ # test if the method is documented
+ if not hasattr(obj, '__doc__') or not obj.__doc__:
+ return skip
+ return False
+
+
+def setup(app):
+ app.connect('autodoc-skip-member', member_function_test)
diff --git a/bob/devtools/templates/doc/img/beat-128x128.png b/bob/devtools/templates/doc/img/beat-128x128.png
new file mode 100644
index 0000000000000000000000000000000000000000..96e1f1f6a334f22adc7119b14a89778b7b0d1609
Binary files /dev/null and b/bob/devtools/templates/doc/img/beat-128x128.png differ
diff --git a/bob/devtools/templates/doc/img/beat-favicon.ico b/bob/devtools/templates/doc/img/beat-favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..acbc0d0056cc417e7e8b71c3aac7231df78e46b7
Binary files /dev/null and b/bob/devtools/templates/doc/img/beat-favicon.ico differ
diff --git a/bob/devtools/templates/doc/img/beat-logo.png b/bob/devtools/templates/doc/img/beat-logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..180021b7d25cf7bee47a4c38039562462265c8ab
Binary files /dev/null and b/bob/devtools/templates/doc/img/beat-logo.png differ
diff --git a/bob/devtools/templates/doc/img/bob-128x128.png b/bob/devtools/templates/doc/img/bob-128x128.png
new file mode 100644
index 0000000000000000000000000000000000000000..787d77b3ec4f143f8dd66162227b5f385f5183f1
Binary files /dev/null and b/bob/devtools/templates/doc/img/bob-128x128.png differ
diff --git a/bob/devtools/templates/doc/img/bob-favicon.ico b/bob/devtools/templates/doc/img/bob-favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..4cc3264302627d40868261add69eb755856611b6
Binary files /dev/null and b/bob/devtools/templates/doc/img/bob-favicon.ico differ
diff --git a/bob/devtools/templates/doc/img/bob-logo.png b/bob/devtools/templates/doc/img/bob-logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..b60858a7068bf45c1ed8e3da12fe244ccdcfe85d
Binary files /dev/null and b/bob/devtools/templates/doc/img/bob-logo.png differ
diff --git a/bob/devtools/templates/doc/index.rst b/bob/devtools/templates/doc/index.rst
new file mode 100644
index 0000000000000000000000000000000000000000..39014e711ab54b7765a98efa212cc81d3dd81f4c
--- /dev/null
+++ b/bob/devtools/templates/doc/index.rst
@@ -0,0 +1,23 @@
+.. -*- coding: utf-8 -*-
+
+.. _{{ package }}:
+
+{{ rst_title }}
+
+.. todo ::
+ Write here a small (1 paragraph) introduction explaining this project. See
+ other projects for examples.
+
+
+
+Users Guide
+===========
+
+.. toctree::
+ :maxdepth: 2
+
+ api
+
+.. todolist::
+
+.. include:: links.rst
diff --git a/bob/devtools/templates/doc/links.rst b/bob/devtools/templates/doc/links.rst
new file mode 100644
index 0000000000000000000000000000000000000000..e3da9b03abd1878ecb88870ed480be9b0600e25d
--- /dev/null
+++ b/bob/devtools/templates/doc/links.rst
@@ -0,0 +1,8 @@
+.. -*- coding: utf-8 -*-
+
+.. This file contains all links we use for documentation in a centralized place
+
+.. _idiap: http://www.idiap.ch
+.. _bob: http://www.idiap.ch/software/bob
+.. _installation: https://www.idiap.ch/software/bob/install
+.. _mailing list: https://www.idiap.ch/software/bob/discuss
diff --git a/bob/devtools/templates/pkg/__init__.py b/bob/devtools/templates/pkg/__init__.py
new file mode 100644
index 0000000000000000000000000000000000000000..2ab1e28b150f0549def9963e9e87de3fdd6b2579
--- /dev/null
+++ b/bob/devtools/templates/pkg/__init__.py
@@ -0,0 +1,3 @@
+# see https://docs.python.org/3/library/pkgutil.html
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
diff --git a/bob/devtools/templates/requirements.txt b/bob/devtools/templates/requirements.txt
new file mode 100644
index 0000000000000000000000000000000000000000..a85739ed615894896a53bef435746f1468b08146
--- /dev/null
+++ b/bob/devtools/templates/requirements.txt
@@ -0,0 +1,2 @@
+setuptools
+numpy
diff --git a/bob/devtools/templates/setup.py b/bob/devtools/templates/setup.py
new file mode 100644
index 0000000000000000000000000000000000000000..ba9f4583816b95c17e49806a37500069e33e9626
--- /dev/null
+++ b/bob/devtools/templates/setup.py
@@ -0,0 +1,66 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+{% if group == 'beat' %}from setuptools import setup, find_packages
+
+def load_requirements(f):
+ retval = [str(k.strip()) for k in open(f, 'rt')]
+ return [k for k in retval if k and k[0] not in ('#', '-')]
+
+install_requires=load_requirements('requirements.txt')
+{% else %}from setuptools import setup, dist
+dist.Distribution(dict(setup_requires=['bob.extension']))
+
+from bob.extension.utils import load_requirements, find_packages
+install_requires = load_requirements()
+{% endif %}
+
+setup(
+
+ name='{{ name }}',
+ version=open("version.txt").read().rstrip(),
+ description='{{ title }}',
+
+ url='https://gitlab.idiap.ch/{{ package }}',
+ {% if license == 'gplv3' %}license='GPLv3'{% else %}license='BSD'{% endif %},
+
+ # there may be multiple authors (separate entries by comma)
+ author='{{ author }}',
+ author_email='{{ email }}',
+
+ # there may be a maintainer apart from the author - you decide
+ #maintainer='?'
+ #maintainer_email='email@example.com'
+
+ # you may add more keywords separating those by commas (a, b, c, ...)
+ keywords = "{{ group }}",
+
+ long_description=open('README.rst').read(),
+
+ # leave this here, it is pretty standard
+ packages=find_packages(),
+ include_package_data=True,
+ zip_safe = False,
+
+ install_requires=install_requires,
+
+ entry_points={
+ # add entry points (scripts, {{ group }} resources here, if any)
+ },
+
+ # check classifiers, add and remove as you see fit
+ # full list here: https://pypi.org/classifiers/
+ # don't remove the Bob framework unless it's not a {{ group }} package
+ classifiers = [
+ {% if group == 'bob' %}'Framework :: Bob',
+ {% endif %}'Development Status :: 4 - Beta',
+ 'Intended Audience :: Science/Research',
+ {% if license == 'gplv3' %}'License :: OSI Approved :: GNU General Public License v3 (GPLv3)'{% else %}'License :: OSI Approved :: BSD License'{% endif %},
+ 'Natural Language :: English',
+ 'Programming Language :: Python',
+ 'Programming Language :: Python :: 3',
+ 'Topic :: Scientific/Engineering :: Artificial Intelligence',
+ 'Topic :: Software Development :: Libraries :: Python Modules',
+ ],
+
+)
diff --git a/bob/devtools/templates/version.txt b/bob/devtools/templates/version.txt
new file mode 100644
index 0000000000000000000000000000000000000000..30893e1121588d631c116255b0ccf2488dfb8dce
--- /dev/null
+++ b/bob/devtools/templates/version.txt
@@ -0,0 +1 @@
+0.0.1b0
diff --git a/conda/meta.yaml b/conda/meta.yaml
index 29370595b82bb6435df83d49604462fc419c9b56..23f5ed3a49f4e3dcb23d41da5afd892968ad6727 100644
--- a/conda/meta.yaml
+++ b/conda/meta.yaml
@@ -45,6 +45,7 @@ requirements:
- pyyaml
- twine
- lxml
+ - jinja2
test:
requires:
@@ -64,6 +65,7 @@ test:
- bdt build --help
- bdt getpath --help
- bdt caupdate --help
+ - bdt new --help
- bdt ci --help
- bdt ci build --help
- bdt ci deploy --help
diff --git a/doc/index.rst b/doc/index.rst
index f26dfe22419bc84c690fa6d00303c9509d0667e2..c5c9d035d96cbd0abd5e2e55cab79a854209585b 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -17,6 +17,7 @@ Documentation
install
release
+ templates
api
ci
diff --git a/doc/templates.rst b/doc/templates.rst
new file mode 100644
index 0000000000000000000000000000000000000000..17d864a31587ab581ac81253059ab444a2d39735
--- /dev/null
+++ b/doc/templates.rst
@@ -0,0 +1,523 @@
+.. vim: set fileencoding=utf-8 :
+
+.. _bob.devtools.templates:
+
+==========================
+ New Package Instructions
+==========================
+
+These instructions describe how create new packages for either Bob_ or BEAT_
+and provides information on how to generate a complete, but empty package from
+scratch.
+
+.. note::
+
+ If you'd like to update part of your package setup, follow similar
+ instructions and then **copy** the relevant files to your **existing**
+ setup, overriding portions you know are correct.
+
+
+.. warning::
+
+ These instructions may change as we get more experience in what needs to be
+ changed. In case that happens, update your package by generating a new
+ setup and copying the relevant parts to your existing package(s).
+
+
+Create a new package
+--------------------
+
+To create a new package, just use the command ``bdt new``. Use its ``--help``
+to get more information about options you can provide.
+
+
+Continuous Integration and Deployment (CI)
+------------------------------------------
+
+If you'd like just to update CI instructions, copy the file ``.gitlab-ci.yml``
+from ``bob/devtools/templates/.gitlab-ci.yml`` **overriding** your existing
+one:
+
+
+.. code-block:: sh
+
+ $ curl -k --silent https://gitlab.idiap.ch/bob/bob.devtools/raw/master/bob/devtools/templates/.gitlab-ci.yml > .gitlab-ci.yml
+ $ git add .gitlab-ci.yml
+ $ git commit -m '[ci] Updated CI instructions' .gitlab-ci.yml
+
+
+The ci file should work out of the box, it is just a reference to a global
+configuration file that is adequate for all packages inside the Bob_/BEAT_
+ecosystem.
+
+You also remember to enable the following options on your project:
+
+1. In the project "Settings" page, make sure builds are enabled
+2. Visit the "Runners" section of your package settings and enable all runners
+ with the `docker` and `macosx` tags.
+3. Setup the coverage regular expression under "CI/CD pipelines" to have the
+ value `^TOTAL.*\s+(\d+\%)$`, which is adequate for figuring out the output
+ of `coverage report`
+
+
+New unexisting dependencies
+---------------------------
+
+If your package depends on **third-party packages** (not Bob_ or BEAT_ existing
+resources) that are not in the CI, but exist on the conda ``defaults`` channel,
+you should perform some extra steps:
+
+1. Add the package in the ``meta.yml`` file of bob-devel in
+ ``bob/bob.conda/conda/bob-devel``:
+
+
+ .. code-block:: yaml
+
+ requirements:
+ host:
+ - python {{ python }}
+ - {{ compiler('c') }}
+ - {{ compiler('cxx') }}
+ # Dependency list of bob packages. Everything is pinned to allow for better
+ # reproducibility. Please keep this list sorted. It is recommended that you
+ # update all dependencies at once (to their latest version) each time you
+ # modify the dependencies here. Use ``conda search`` to find the latest
+ # version of packages.
+ - boost 1.65.1
+ - caffe 1.0 # [linux]
+ - click 6.7
+ - click-plugins 1.0.3
+ - ..
+ - [your dependency here]
+
+2. At the same file, update the version with the current date, in the format
+ preset.
+
+ .. code-block:: yaml
+
+ package:
+ name: bob-devel
+ version: 2018.05.02 <-- HERE
+
+3. Update the ``beat-devel`` and ``bob-devel`` versions in the ``meta.yml``
+ file inside ``bob/bob.conda/conda/beat-devel``:
+
+ .. code-block:: yaml
+
+ package:
+ name: beat-devel
+ version: 2018.05.02 <-- HERE
+
+ [...]
+
+ requirements:
+ host:
+ - python {{ python }}
+ - bob-devel 2018.05.02 <-- HERE
+ - requests 2.18.4
+
+4. Update the ``conda_build_config.yaml`` in
+ ``bob/bob.devtools/bob/devtools/data/conda_build_config.yaml`` with your
+ dependencies, and with the updated version of bob-devel and beat-devel. See
+ `this here <https://gitlab.idiap.ch/bob/bob.conda/merge_requests/363>`_ and
+ `this MR here <https://gitlab.idiap.ch/bob/bob.admin/merge_requests/89>`_
+ for concrete examples on how to do this.
+
+ .. note::
+
+ **This step should be performed after bob.conda's pipeline on master is
+ finished** (i.e. perform steps 1 to 3 in a branch, open a merge request
+ and wait for it to be merged, and wait for the new master branch to be
+ "green").
+
+
+Conda recipe
+------------
+
+The CI system is based on conda recipes to build the package. The recipes are
+located in the ``conda/meta.yaml`` file of each package. You can start
+to modify the recipe of each package from the template generated by ``bdt
+template`` command as explained above, for new packages.
+
+The template ``meta.yaml`` file in this package is up-to-date. If you see a
+Bob_ or BEAT_ package that does not look similar to this recipe, please let us
+know as soon as possible.
+
+You should refrain from modifying the recipe except for the places that you are
+asked to modify. We want to keep recipes as similar as possible so that
+updating all of them in future would be possible by a script.
+
+Each recipe is unique to the package and need to be further modified by the
+package maintainer to work. The reference definition of the ``meta.yaml`` file
+is https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html.
+The ``meta.yaml`` file (referred to as the recipe) will contain duplicate
+information that is already documented in ``setup.py``, ``requirements.txt``,
+and, eventually, in ``test-requirements.txt``. For the time being you have to
+maintain both the ``meta.yaml`` file and the other files.
+
+Let's walk through the ``conda/meta.yaml`` file (the recipe) that you just
+created and further customize it to your package. You need to carry out all
+the steps below otherwise the template ``meta.yaml`` is not usable as it is.
+
+
+Entry-points in the ``build`` section
+=====================================
+
+You need to check if your package has any ``console_scripts``. These are
+documented in ``setup.py`` of each package. You need to list the
+``console_scripts`` entry points (only ``console_scripts``; other entry points
+**should not** be listed in ``conda/meta.yaml``) in the build section of the
+recipe.
+
+* If there are no ``console_scripts``, then you don't need to add anything
+* If there are some, list them in the ``conda/meta.yaml`` file as well:
+ (`information on entry-points at conda recipes here
+ <https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html#python-entry-points>`_).
+ For example, if the ``setup.py`` file contains:
+
+ .. code-block:: python
+
+ entry_points={
+ 'console_scripts': [
+ 'jman = gridtk.script.jman:main',
+ 'jgen = gridtk.script.jgen:main',
+ ]
+
+ You would add the following entry-points on ``conda/meta.yaml``:
+
+ .. code-block:: yaml
+
+ build: # add entry points at the "build" section
+ entry_points:
+ - jman = gridtk.script.jman:main
+ - jgen = gridtk.script.jgen:main
+
+
+.. note::
+
+ If your conda package runs only on linux, please add this recipe under
+ build:
+
+ .. code-block:: yaml
+
+ build:
+ skip: true # [not linux]
+
+
+Build and host dependencies
+===========================
+
+This part of the recipe lists the packages that are required during build time
+(`information on conda package requirements here
+<https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html#requirements-section>`_).
+Having build and host requirements separately enables cross-compiling of the
+recipes. Here are some notes:
+
+* If the packages does not contain C/C++ code, you may skip adding build
+ dependencies (pure-python packages do not typically have build dependencies
+ (that is, dependencies required for installing the package itself, except for
+ ``setuptools`` and ``python`` itself)
+* If the package does contain C/C++ code, then you need to augment the entries
+ in the section ``requirements / build`` to include:
+
+ .. code-block:: yaml
+
+ requirements:
+ build:
+ - {{ compiler('c') }}
+ - {{ compiler('cxx') }}
+ - pkg-config {{ pkg_config }}
+ - cmake {{ cmake }}
+
+ The pkg-config and cmake lines are optional. If the package uses them, you
+ need to include these as well.
+
+* List all the packages that are in ``requirements.txt`` in the
+ ``requirements / host`` section, adding a new line per dependence. For
+ example, here is what ``bob/bob.measure`` has in its host:
+
+ .. code-block:: yaml
+
+ host:
+ - python {{ python }}
+ - setuptools {{ setuptools }}
+ - bob.extension
+ - bob.blitz
+ - bob.core
+ - bob.math
+ - bob.io.base
+ - matplotlib {{ matplotlib }}
+ - libblitz {{ libblitz }}
+ - boost {{ boost }}
+ - numpy {{ numpy }}
+ - docopt {{ docopt }}
+
+ You need to add a jinja variable like `{{ dependence }}` in front of the
+ dependencies that we **do not** develop. The jinja variable name should not
+ contain ``.`` or ``-``; replace those with ``_``. Bob_ and BEAT_ packages
+ (and gridtk) should be listed as is.
+
+* Unlike ``pip``, ``conda`` is **not** limited to Python programs. If the
+ package depends on some non-python package (like ``boost``), you need to list
+ it in the `host` section.
+
+
+Runtime dependencies
+====================
+
+In the ``requirements / run`` section of the conda recipe, you will list
+dependencies that are needed when a package is used (run-time) dependencies.
+Usually, for pure-python packages, you list the same packages as in the host
+section also in the run section. This is simple, **but** conda build version
+3.x introduced a new concept named ``run_exports`` (`read more about this
+feature here
+<https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html#pin-downstream>`_)
+which makes this slightly complicated. In summary, you put all the run-time
+dependencies in the ``requirements / run`` section **unless** this dependency
+was listed in the host section **and** the dependency has a ``run_exports`` set
+on their own recipe (what a mess!). The problem is that you cannot easily find
+which packages actually do have ``run_exports`` unless you look at their conda
+recipe. Usually, all the C/C++ libraries like ``jpeg``, ``hdf5`` have
+``run_exports`` (with exceptions - ``boost``, for instance, does not have
+one!). All ``bob`` packages have this too. For example, here is what is
+inside the ``requirements / run`` section of ``bob/bob.measure``:
+
+.. code-block:: yaml
+
+ run:
+ - setuptools
+ - matplotlib
+ - boost
+ - {{ pin_compatible('numpy') }}
+ - docopt
+
+The ``pin_compatible`` jinja function is `explained in here
+<https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html#pin-downstream>`_.
+You need to use it on ``numpy`` if and only if you use ``numpy`` in C level.
+Otherwise, just list numpy normally. We do not know of any other package
+besides numpy used in C level that needs to use the ``pin_compatible`` jinja
+function.
+
+Here is a list of packages that we know that they have ``run_exports``:
+
+.. code-block:: yaml
+
+ - bzip2
+ - dbus
+ - expat
+ - ffmpeg
+ - fontconfig
+ - freetype
+ - giflib
+ - glib
+ - gmp
+ - gst-plugins-base
+ - gstreamer
+ - hdf5
+ - icu
+ - jpeg
+ - kaldi
+ - libblitz
+ - libboost
+ - libffi
+ - libmatio
+ - libogg
+ - libopus
+ - libpng
+ - libsvm
+ - libtiff
+ - libvpx
+ - libxcb
+ - libxml2
+ - menpo
+ - mkl # not this one but mkl-devel - no need to list mkl if you use mkl-devel in host
+ - mkl-devel
+ - ncurses
+ - openfst
+ - openssl
+ - readline
+ - sox
+ - speex
+ - speexdsp
+ - sqlite
+ - tk
+ - vlfeat
+ - xz
+ - yaml
+ - zlib
+
+
+Testing entry-points
+====================
+
+If you listed some of your ``setup.py`` ``console_sripts`` in the ``build / entry_points`` section of the conda recipe, it is adviseable you test these. For
+example, if you had the examples entry points above, you would test them like:
+
+.. code-block:: yaml
+
+ test:
+ imports:
+ - {{ name }}
+ commands:
+ - jman --help
+ - jgen --help
+
+
+Test-time dependencies
+======================
+
+You need to list the packages here that are required during **test-time only**.
+By default, add some packages. Do not remove them. The test-time dependencies
+are listed in ``test-requirements.txt``, which is an optional file, not
+included in the template. It has the same syntax as ``requirements.txt``, but
+list only things that are needed to test the package and are not part of its
+runtime. If you do not need any test-time dependencies, you may skip these
+instructions.
+
+You may read more information about `conda test-time dependencies here <https://conda.io/docs/user-guide/tasks/build-packages/define-metadata.html#test-requirements>`_.
+
+
+Left-over conda build files
+---------------------------
+
+The conda build command may create a temporary file named ``record.txt`` in the
+project directory. Please make sure it is added in the ``.gitignore`` file so
+that is not committed to the project repository by mistake.
+
+
+Database packages and packages with extra data
+----------------------------------------------
+
+Sometimes databases or other packages require an extra download command after
+installation. If this extra data is downloaded from Idiap severs, you can
+include this data in the conda package itself to avoid downloading it two
+times. If the data is supposed to be downloaded from somewhere other than Idiap
+servers, do not include it in its conda package. For example, the database
+packages typically require this download command to be added in the
+``build:script`` section:
+
+
+.. code-block:: yaml
+
+ - python setup.py install --single-version-externally-managed --record record.txt # this line is already in the recipe. Do not add.
+ - bob_dbmanage.py {{ name.replace('bob.db.', '') }} download --missing
+
+
+Licensing
+---------
+
+There are 2 possible cases for the majority of packages in our ecosystem:
+
+1. If the package is supposed to be licensed under (a 3-clause) BSD license,
+ ensure a file called ``LICENSE`` exists at the root of your package and has
+ the correct authorship information.
+2. If the package is supposed to be licensed under GPLv3 license, then ensure a
+ file called ``COPYING`` exists on the root of your package
+
+The templating generation has an option to address this.
+
+More info about Idiap's `open-source policy here
+<https://secure.idiap.ch/intranet/services/technology-transfer/idiap-open-source-policy>`.
+
+
+Headers
+-------
+
+Sometimes people add headers with licensing terms to their files. You should
+inspect your library to make sure you don't have those. The Idiap TTO says this
+strategy is OK and simplifies our lives. Make the headers of each file you have
+as simple as possible, so they don't get outdated in case things change.
+
+Here is a minimal example (adapt to the language comment style if needed):
+
+```text
+#!/usr/bin/env python
+# vim: set fileencoding=utf-8 :
+```
+
+It is OK to also have your author name on the file if you wish to do so.
+**Don't repeat licensing terms** already explained on the root of your package
+and on the `setup.py` file. If we need to change the license, it is painful to
+go through all the headers.
+
+
+The ``setup.py`` file
+---------------------
+
+The ``setup.py`` should be changed to include eventual ``entry_points`` you
+also included in the ``conda/meta.yaml``. We cannot guess these.
+
+
+Buildout
+--------
+
+The default buildout file ``buildout.cfg`` should buildout from the installed
+distribution (use ``bdt create`` for that purpose) and **avoid mr.developer
+checkouts**. If you have one of those, move it to ``develop.cfg`` and create a
+new `buildout.cfg` which should be as simple as possible. The template project
+provided by this package takes care of this.
+
+
+The ``README.rst`` file
+-----------------------
+
+You should make the README smaller and easier to maintain. As of today, many
+packages contain outdated installation instructions or outdated links. More
+information can always be found at the documentation, which is automatically
+linked from the badges.
+
+You may want to revise the short introduction after automatic template
+generation. Make it short, a single phrase is the most common size.
+
+
+Sphinx documentation
+--------------------
+
+Sphinx documentation configuration goes to a file named ``doc/conf.py``. The
+file ``doc/index.rst`` is the root of the documentation for your package.
+
+The new documentation configuration allows for two *optional* configuration
+text files to be placed inside the ``doc/`` directory, alongside the ``conf.py`` file:
+
+* ``extra-intersphinx.txt``, which lists extra packages that should be
+ cross-linked to the documentation (as with `Sphinx's intersphinx extension
+ <http://www.sphinx-doc.org/en/stable/ext/intersphinx.html>`_. The format of
+ this text file is simple: it contains the PyPI names of packages to
+ cross-reference. One per line.
+* ``nitpick-exceptions.txt``, which lists which documentation objects to ignore
+ (for warnings and errors). The format of this text file is two-column. On the
+ first column, you should refer to `Sphinx the object
+ type <http://www.sphinx-doc.org/en/stable/domains.html#the-python-domain>`_,
+ e.g. ``py:class``, followed by a space and then the name of the that should be
+ ignored. E.g.: ``bob.bio.base.Database``. The file may optionally contain
+ empty lines. Lines starting with ``#`` are ignored (so you can comment on why
+ you're ignoring these objects). Ignoring errors should be used only as a
+ **last resource**. You should first try to fix the errors as best as you can,
+ so your documentation links are properly working.
+
+
+.. tip::
+
+ You may use ``bdt dumpsphinx`` to list *documented* objects in remote sphinx
+ documentations. This resource can be helpful to fix issues during sphinx
+ documentation building.
+
+
+Project logo and branding
+-------------------------
+
+In the gitlab Settings / General page of your project, update the logo to use
+one of ours:
+
+* For Bob_:
+
+ .. image:: https://gitlab.idiap.ch/bob/bob.devtools/raw/master/bob/devtools/templates/doc/img/bob-128x128.png
+ :alt: Bob's logo for gitlab
+
+* Fob BEAT_:
+
+ .. image:: https://gitlab.idiap.ch/bob/bob.devtools/raw/master/bob/devtools/templates/doc/img/beat-128x128.png
+ :alt: BEAT's logo for gitlab
+
+
+.. include:: links.rst
diff --git a/setup.py b/setup.py
index 518246bafc269f175a316162b54bae655fdf1452..178fd46511dc7f630499511bcee83ddd0b802bd6 100644
--- a/setup.py
+++ b/setup.py
@@ -18,6 +18,7 @@ requires = [
'pyyaml',
'twine',
'lxml',
+ 'jinja2',
]
setup(
@@ -43,6 +44,7 @@ setup(
],
'bdt.cli': [
'release = bob.devtools.scripts.release:release',
+ 'new = bob.devtools.scripts.new:new',
'changelog = bob.devtools.scripts.changelog:changelog',
'lasttag = bob.devtools.scripts.lasttag:lasttag',
'visibility = bob.devtools.scripts.visibility:visibility',