pax_global_header00006660000000000000000000000064126404763010014515gustar00rootroot0000000000000052 comment=798eabbcdc884670d96e5120269781f11653d114 .gitignore000066400000000000000000000004331264047630100130510ustar00rootroot00000000000000*.py[oc] # Temp files *~ ~* .*~ \#* .#* *# # Build files build/ dh_virtualenv.egg-info/ # Sphinx build doc/_build # Generated man page doc/dh_virtualenv.1 # virtualenv local/ include/ man/ # buildpackage debian/*.debhelper debian/*.substvars debian/dh-virtualenv/ debian/files .travis.yml000066400000000000000000000001611264047630100131700ustar00rootroot00000000000000language: python python: - "2.6" - "2.7" install: "pip install -r travis-requirements.txt" script: nosetests LICENSE000066400000000000000000000432541264047630100120760ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) 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 this service 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 make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. 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. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), 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 distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the 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 a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE 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. 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 convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision 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, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This 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. README.md000066400000000000000000000044771264047630100123540ustar00rootroot00000000000000# dh-virtualenv [![Build Status](https://travis-ci.org/spotify/dh-virtualenv.png)](https://travis-ci.org/spotify/dh-virtualenv) dh-virtualenv is a tool that aims to combine Debian packaging with self-contained virtualenv based Python deployments. The idea behind the dh-virtualenv is to be able to combine power of Debian packaging with the sandboxed nature of virtualenvs. In addition to this, using virtualenv enables installing requirements via [Python Package Index](http://pypi.python.org) instead of relying on the operating system provided Python packages. The only limiting factor is that you have to run the same Python interpreter as the operating system. ## Using dh-virtualenv Using dh-virtualenv is fairly straightforward. First, you need to define the requirements of your package in `requirements.txt` file, in [the format defined by pip](https://pip.pypa.io/en/latest/user_guide.html#requirements-files). To build a package using dh-virtualenv, you need to add dh-virtualenv in to your build dependencies and write following `debian/rules` file: %: dh $@ --with python-virtualenv Note that you might need to provide additional build dependencies too, if your requirements require them. Also, you are able to define the root path for your source directory using `--sourcedirectory` or `-D` argument: %: dh $@ --with python-virtualenv --sourcedirectory=root/srv/application NOTE: Be aware that the configuration in debian/rules expects tabs instead of spaces! Once the package is built, you have a virtualenv contained in a Debian package and upon installation it gets placed, by default, under `/usr/share/python/`. For more information and usage documentation, check the accompanying documentation in the `doc` folder. ## How does it work? To do the packaging, the package extends debhelper's sequence by providing a new command in sequence, `dh_virtualenv`, which effectively replaces following commands from the sequence: * `dh_auto_clean` * `dh_auto_install` * `dh_python2` * `dh_pycentral` * `dh_pysupport` In the sequence the dh_virtualenv is inserted right after dh_perl. ## Running tests $ nosetests ./test/test_deployment.py ## License Copyright (c) 2013 Spotify AB dh-virtualenv is licensed under GPL v2 or later. Full license is available in the `LICENSE` file. autoscripts/000077500000000000000000000000001264047630100134415ustar00rootroot00000000000000autoscripts/postinst-dh-virtualenv000066400000000000000000000051721264047630100200420ustar00rootroot00000000000000# dh-virtualenv postinst autoscript set -e #ARGS# # set to empty to enable verbose output test "$DH_VERBOSE" = "1" && DH_VENV_DEBUG="" || DH_VENV_DEBUG=: $DH_VENV_DEBUG set -x dh_venv_safe_interpreter_update() { # get Python version used local pythonX_Y=$(cd "$dh_venv_install_dir/lib" && ls -1d python[2-9].*[0-9] | tail -n1) local i for i in python ${pythonX_Y%.*} ${pythonX_Y}; do local interpreter_path="$dh_venv_install_dir/bin/$i" # skip any symlinks, and make sure we have an existing target test ! -L "$interpreter_path" || continue test -x "$interpreter_path" || continue # skip if already identical if cmp "/usr/bin/$pythonX_Y" "$interpreter_path" >/dev/null 2>&1; then continue fi # hardlink or copy new interpreter cp -fpl "/usr/bin/$pythonX_Y" "$interpreter_path,new" \ || cp -fp "/usr/bin/$pythonX_Y" "$interpreter_path,new" \ || rm -f "$interpreter_path,new" \ || true # make a backup (once) test -f "$interpreter_path,orig" || ln "$interpreter_path" "$interpreter_path,orig" # atomic move if test -x "$interpreter_path,new" && mv "$interpreter_path,new" "$interpreter_path"; then echo "Successfully updated $interpreter_path" else echo >&2 "WARNING: Some error occured while updating $interpreter_path" fi done } case "$1" in configure|reconfigure) $DH_VENV_DEBUG echo "$0 $1 called with $# args:" "$@" dh_venv_safe_interpreter_update ;; triggered) $DH_VENV_DEBUG echo "$0 $1 called with $# args:" "$@" for trigger in $2; do case "$trigger" in /usr/bin/python?.*) # this trigger might be for the "wrong" interpreter (other version), # but the "cmp" in "dh_venv_safe_interpreter_update" and the fact we only # ever look at our own Python version catches that dh_venv_safe_interpreter_update ;; dh-virtualenv-interpreter-update) dh_venv_safe_interpreter_update ;; *) #echo >&2 "ERROR:" $(basename "$0") "called with unknown trigger '$2'" #exit 1 ;; esac done ;; abort-upgrade|abort-remove|abort-deconfigure) ;; *) #echo >&2 "ERROR:" $(basename "$0") "called with unknown argument '$1'" #exit 1 ;; esac $DH_VENV_DEBUG set +x # END dh-virtualenv postinst autoscript bin/000077500000000000000000000000001264047630100116315ustar00rootroot00000000000000bin/dh_virtualenv000077500000000000000000000064211264047630100144340ustar00rootroot00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- # Copyright (c) 2013-2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . import inspect import logging import os import sys # The debpython resides here sys.path.insert(1, '/usr/share/python/') from debpython.debhelper import DebHelper from dh_virtualenv import Deployment from dh_virtualenv.cmdline import get_default_parser logging.basicConfig(format='%(levelname).1s: %(module)s:%(lineno)d: ' '%(message)s') log = logging.getLogger(__name__) def _shell_vars(**kwargs): """Convert the given values into the equivalent shell snippet defining them.""" return '\n'.join("dh_venv_{0}='{1}'".format(k, v.replace("'", r"'\''")) for k, v in sorted(kwargs.iteritems())) def main(): parser = get_default_parser() options, args = parser.parse_args() options.compile_all = False # for DebHelper.save() # TODO: Reduce redundancy with this and the Deployment.from_options verbose = options.verbose or os.environ.get('DH_VERBOSE') == '1' if verbose: log.setLevel(logging.DEBUG) if 'nocheck' in os.environ.get('DEB_BUILD_OPTIONS', ''): do_test = False else: do_test = options.test # Older DebHelpers, like the one on Debian Squeeze, expect to be # passed the packages keyword argument. Newer (like Ubuntu # Precise) expect the whole options to be passed. arguments = inspect.getargspec(DebHelper.__init__).args if 'packages' in arguments: dh = DebHelper(packages=options.package or None) else: dh = DebHelper(options) for package, details in dh.packages.items(): def _info(msg): log.info('{0}: {1}'.format(package, msg)) _info('Processing package...') deploy = Deployment.from_options(package, options) if options.autoscripts: _info('Adding autoscripts...') dh.autoscript(package, 'postinst', 'postinst-dh-virtualenv', _shell_vars( package=package, install_dir=deploy.virtualenv_install_dir, )) _info('Creating virtualenv') deploy.create_virtualenv() _info('Installing dependencies') deploy.install_dependencies() _info('Installing package') deploy.install_package() if do_test: _info('Running tests') deploy.run_tests() else: _info('Skipped tests') _info('Fixing paths') deploy.fix_activate_path() deploy.fix_shebangs() deploy.fix_local_symlinks() _info('dh-virtualenv: All done!') dh.save() if __name__ == '__main__': sys.exit(main() or 0) debian/000077500000000000000000000000001264047630100123035ustar00rootroot00000000000000debian/changelog000066400000000000000000000021201264047630100141500ustar00rootroot00000000000000dh-virtualenv (0.11-1) unstable; urgency=low * New upstream release -- Jyrki Pulliainen Tue, 29 Dec 2015 14:20:14 +0200 dh-virtualenv (0.10-1) unstable; urgency=low * New upstream release -- Jyrki Pulliainen Thu, 20 Aug 2015 13:00:55 +0200 dh-virtualenv (0.9-1) experimental; urgency=low * New upstream release -- Jyrki Pulliainen Mon, 09 Mar 2015 09:59:26 +0100 dh-virtualenv (0.8-1) experimental; urgency=low * New upstream release -- Jyrki Pulliainen Thu, 02 Oct 2014 10:06:32 +0200 dh-virtualenv (0.7-2) unstable; urgency=low * Fix virtualenv dependency. Closes: #751192 * Fix cleaning with dh_auto_clean -- Jyrki Pulliainen Wed, 11 Jun 2014 16:54:10 +0200 dh-virtualenv (0.7-1) unstable; urgency=low * New upstream release * Closes: #738964 -- Jyrki Pulliainen Sun, 18 May 2014 19:29:13 +0200 dh-virtualenv (0.6-1) unstable; urgency=low * Closes: #727620 -- Jyrki Pulliainen Fri, 10 Jan 2014 16:33:30 +0100 debian/compat000066400000000000000000000000011264047630100135000ustar00rootroot000000000000009debian/control000066400000000000000000000012061264047630100137050ustar00rootroot00000000000000Source: dh-virtualenv Section: python Priority: extra Maintainer: Jyrki Pulliainen Build-Depends: debhelper (>= 9), python(>= 2.6.6-3~), python-setuptools, python-sphinx, python-mock Standards-Version: 3.9.6 Homepage: http://www.github.com/spotify/dh-virtualenv X-Python-Version: >= 2.6 Package: dh-virtualenv Architecture: all Depends: ${python:Depends}, ${misc:Depends}, ${sphinxdoc:Depends}, virtualenv | python-virtualenv (>= 1.7) Description: wrap and build python packages using virtualenv This package provides a dh sequencer that helps you to deploy your virtualenv wrapped installation inside a Debian package. debian/copyright000066400000000000000000000021421264047630100142350ustar00rootroot00000000000000Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: dh-virtualenv Upstream-Contact: Jyrki Pulliainen Source: http://www.github.com/spotify/dh-virtualenv Files: * Copyright: 2013 Spotify AB License: GPL-2+ Copyright (C) 2013 Spotify AB . 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 2 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, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. . Comment: . On a Debian system you can find a copy of this license in /usr/share/common-licenses/GPL-2. debian/dh-virtualenv.doc-base000066400000000000000000000004231264047630100164710ustar00rootroot00000000000000Document: dh-virtualenv Title: dh-virtualenv documentation Author: Spotify Abstract: This manual describes dh-virtualenv and how to use it. Section: Programming Format: HTML Index: /usr/share/doc/dh-virtualenv/html/index.html Files: /usr/share/doc/dh-virtualenv/html/*.html debian/dh-virtualenv.install000066400000000000000000000001231264047630100164570ustar00rootroot00000000000000lib/* usr/share/perl5 autoscripts/*-dh-virtualenv /usr/share/debhelper/autoscripts debian/dh-virtualenv.manpages000066400000000000000000000000241264047630100166040ustar00rootroot00000000000000doc/dh_virtualenv.1 debian/rules000077500000000000000000000005521264047630100133650ustar00rootroot00000000000000#!/usr/bin/make -f %: dh $@ --with python2 --with sphinxdoc override_dh_auto_clean: rm -rf doc/_build rm -f doc/dh_virtualenv.1 rm -rf dh_virtualenv.egg-info dh_auto_clean override_dh_auto_build: rst2man doc/dh_virtualenv.1.rst > doc/dh_virtualenv.1 dh_auto_build override_dh_installdocs: python setup.py build_sphinx dh_installdocs doc/_build/html debian/source/000077500000000000000000000000001264047630100136035ustar00rootroot00000000000000debian/source/format000066400000000000000000000000131264047630100150100ustar00rootroot000000000000003.0 (quilt)debian/watch000066400000000000000000000002341264047630100133330ustar00rootroot00000000000000version=3 opts=filenamemangle=s/.+\/v?(\d\S*)\.tar\.gz/dh-virtualenv-$1.tar.gz/ \ https://github.com/spotify/dh-virtualenv/releases .*/v?(\d\S*)\.tar\.gz dh_virtualenv/000077500000000000000000000000001264047630100137335ustar00rootroot00000000000000dh_virtualenv/__init__.py000066400000000000000000000013771264047630100160540ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Copyright (c) 2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . from .deployment import Deployment dh_virtualenv/cmdline.py000066400000000000000000000117221264047630100157230ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Copyright (c) 2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . """Helpers to handle debhelper command line options.""" import os from optparse import OptionParser, SUPPRESS_HELP class DebhelperOptionParser(OptionParser): """Special OptionParser for handling Debhelper options. Basically this means converting -O--option to --option before parsing. """ def parse_args(self, args=None, values=None): args = [o[2:] if o.startswith('-O-') else o for o in self._get_args(args)] args.extend(os.environ.get('DH_OPTIONS', '').split()) # Unfortunately OptionParser is an old style class :( return OptionParser.parse_args(self, args, values) def get_default_parser(): usage = '%prog [options]' parser = DebhelperOptionParser(usage, version='%prog 0.11') parser.add_option('-p', '--package', action='append', help='act on the package named PACKAGE') parser.add_option('-N', '--no-package', action='append', help='do not act on the specified package') parser.add_option('-v', '--verbose', action='store_true', default=False, help='Turn on verbose mode') parser.add_option('-s', '--setuptools', action='store_true', default=False, help='Use Setuptools instead of Distribute') parser.add_option('--extra-index-url', action='append', help='extra index URL to pass to pip.', default=[]) parser.add_option('--preinstall', action='append', help=('package to install before processing ' 'requirements.txt.'), default=[]) parser.add_option('--extra-pip-arg', action='append', help='Extra args for the pip binary.' 'You can use this flag multiple times to pass in' ' parameters to pip.', default=[]) parser.add_option('--pypi-url', help='Base URL of the PyPI server') parser.add_option('--python', help='The Python to use') parser.add_option('--builtin-venv', action='store_true', help='Use the built-in venv module. Only works on ' 'Python 3.4 and later.') parser.add_option('-D', '--sourcedirectory', dest='sourcedirectory', help='The source directory') parser.add_option('--no-test', action='store_false', dest='test', help="Don't run tests for the package. Useful " "for example when you have packaged with distutils.", default=True) parser.add_option('-n', '--noscripts', action='store_false', dest='autoscripts', help="Do not modify postinst and similar scripts.", default=True) parser.add_option('-S', '--use-system-packages', action='store_true', dest='use_system_packages', help="Set the --system-site-packages flag in virtualenv " "creation, allowing you to use system packages.", default=False) parser.add_option('--skip-install', action='store_true', default=False, dest='skip_install', help="Skip running pip install within the source directory."); parser.add_option('--install-suffix', dest='install_suffix', help="Override installation path suffix"); parser.add_option('--requirements', dest='requirements_filename', help='Specify the filename for requirementst.txt', default='requirements.txt') # Ignore user-specified option bundles parser.add_option('-O', help=SUPPRESS_HELP) parser.add_option('-a', '--arch', dest="arch", help=("Act on architecture dependent packages that " "should be built for the build architecture. " "This option is ignored"), action="store", type="string") parser.add_option('-i', '--indep', dest="indep", help=("Act on all architecture independent packages. " "This option is ignored"), action="store_true") return parser dh_virtualenv/deployment.py000066400000000000000000000222041264047630100164650ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Copyright (c) 2013 - 2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . import os import re import shutil import subprocess import tempfile ROOT_ENV_KEY = 'DH_VIRTUALENV_INSTALL_ROOT' DEFAULT_INSTALL_DIR = '/usr/share/python/' class Deployment(object): def __init__(self, package, extra_urls=[], preinstall=[], pypi_url=None, setuptools=False, python=None, builtin_venv=False, sourcedirectory=None, verbose=False, extra_pip_arg=[], use_system_packages=False, skip_install=False, install_suffix=None, requirements_filename='requirements.txt'): self.package = package install_root = os.environ.get(ROOT_ENV_KEY, DEFAULT_INSTALL_DIR) self.install_suffix = install_suffix self.debian_root = os.path.join( 'debian', package, install_root.lstrip('/')) if install_suffix is None: self.virtualenv_install_dir = os.path.join(install_root, self.package) self.package_dir = os.path.join(self.debian_root, package) else: self.virtualenv_install_dir = os.path.join(install_root, install_suffix) self.package_dir = os.path.join(self.debian_root, install_suffix) self.bin_dir = os.path.join(self.package_dir, 'bin') self.local_bin_dir = os.path.join(self.package_dir, 'local', 'bin') self.extra_urls = extra_urls self.preinstall = preinstall self.extra_pip_arg = extra_pip_arg self.pypi_url = pypi_url self.log_file = tempfile.NamedTemporaryFile() self.verbose = verbose self.setuptools = setuptools self.python = python self.builtin_venv = builtin_venv self.sourcedirectory = '.' if sourcedirectory is None else sourcedirectory self.use_system_packages = use_system_packages self.skip_install = skip_install self.requirements_filename = requirements_filename @classmethod def from_options(cls, package, options): verbose = options.verbose or os.environ.get('DH_VERBOSE') == '1' return cls(package, extra_urls=options.extra_index_url, preinstall=options.preinstall, pypi_url=options.pypi_url, setuptools=options.setuptools, python=options.python, builtin_venv=options.builtin_venv, sourcedirectory=options.sourcedirectory, verbose=verbose, extra_pip_arg=options.extra_pip_arg, use_system_packages=options.use_system_packages, skip_install=options.skip_install, install_suffix=options.install_suffix, requirements_filename=options.requirements_filename) def clean(self): shutil.rmtree(self.debian_root) def create_virtualenv(self): if self.builtin_venv: virtualenv = [self.python, '-m', 'venv'] else: virtualenv = ['virtualenv'] if self.use_system_packages: virtualenv.append('--system-site-packages') else: virtualenv.append('--no-site-packages') if self.setuptools: virtualenv.append('--setuptools') if self.verbose: virtualenv.append('--verbose') if self.python: virtualenv.extend(('--python', self.python)) virtualenv.append(self.package_dir) subprocess.check_call(virtualenv) # We need to prefix the pip run with the location of python # executable. Otherwise it would just blow up due to too long # shebang-line. self.pip_prefix = [ os.path.abspath(os.path.join(self.bin_dir, 'python')), os.path.abspath(os.path.join(self.bin_dir, 'pip')), ] if self.verbose: self.pip_prefix.append('-v') self.pip_prefix.append('install') if self.pypi_url: self.pip_prefix.append('--pypi-url={0}'.format(self.pypi_url)) self.pip_prefix.extend([ '--extra-index-url={0}'.format(url) for url in self.extra_urls ]) self.pip_prefix.append('--log={0}'.format(os.path.abspath(self.log_file.name))) # Add in any user supplied pip args if self.extra_pip_arg: self.pip_prefix.extend(self.extra_pip_arg) def pip(self, *args): return self.pip_prefix + list(args) def install_dependencies(self): # Install preinstall stage packages. This is handy if you need # a custom package to install dependencies (think something # along lines of setuptools), but that does not get installed # by default virtualenv. if self.preinstall: subprocess.check_call(self.pip(*self.preinstall)) requirements_path = os.path.join(self.sourcedirectory, self.requirements_filename) if os.path.exists(requirements_path): subprocess.check_call(self.pip('-r', requirements_path)) def run_tests(self): python = os.path.abspath(os.path.join(self.bin_dir, 'python')) setup_py = os.path.join(self.sourcedirectory, 'setup.py') if os.path.exists(setup_py): subprocess.check_call([python, 'setup.py', 'test'], cwd=self.sourcedirectory) def fix_shebangs(self): """Translate /usr/bin/python and /usr/bin/env python sheband lines to point to our virtualenv python. """ grep_proc = subprocess.Popen( ['grep', '-l', '-r', '-e', r'^#!.*bin/\(env \)\?python', self.bin_dir], stdout=subprocess.PIPE ) files, stderr = grep_proc.communicate() files = files.strip() if not files: return pythonpath = os.path.join(self.virtualenv_install_dir, 'bin/python') for f in files.split('\n'): subprocess.check_call( ['sed', '-i', r's|^#!.*bin/\(env \)\?python|#!{0}|'.format( pythonpath), f]) def fix_activate_path(self): """Replace the `VIRTUAL_ENV` path in bin/activate to reflect the post-install path of the virtualenv. """ activate_settings = [ [ 'VIRTUAL_ENV="{0}"'.format(self.virtualenv_install_dir), r'^VIRTUAL_ENV=.*$', "activate" ], [ 'setenv VIRTUAL_ENV "{0}"'.format(self.virtualenv_install_dir), r'^setenv VIRTUAL_ENV.*$', "activate.csh" ], [ 'set -gx VIRTUAL_ENV "{0}"'.format(self.virtualenv_install_dir), r'^set -gx VIRTUAL_ENV.*$', "activate.fish" ], ] for activate_args in activate_settings: virtualenv_path = activate_args[0] pattern = re.compile(activate_args[1], flags=re.M) activate_file = activate_args[2] with open(os.path.join(self.bin_dir, activate_file), 'r+') as fh: content = pattern.sub(virtualenv_path, fh.read()) fh.seek(0) fh.truncate() fh.write(content) def install_package(self): if not self.skip_install: subprocess.check_call(self.pip('.'), cwd=os.path.abspath(self.sourcedirectory)) def fix_local_symlinks(self): # The virtualenv might end up with a local folder that points outside the package # Specifically it might point at the build environment that created it! # Make those links relative # See https://github.com/pypa/virtualenv/commit/5cb7cd652953441a6696c15bdac3c4f9746dfaa1 local_dir = os.path.join(self.package_dir, "local") if not os.path.isdir(local_dir): return elif os.path.samefile(self.package_dir, local_dir): # "local" points directly to its containing directory os.unlink(local_dir) os.symlink(".", local_dir) return for d in os.listdir(local_dir): path = os.path.join(local_dir, d) if not os.path.islink(path): continue existing_target = os.readlink(path) if not os.path.isabs(existing_target): # If the symlink is already relative, we don't # want to touch it. continue new_target = os.path.relpath(existing_target, local_dir) os.unlink(path) os.symlink(new_target, path) doc/000077500000000000000000000000001264047630100116265ustar00rootroot00000000000000doc/Makefile000066400000000000000000000127301264047630100132710ustar00rootroot00000000000000# Makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build PAPER = BUILDDIR = _build # Internal variables. PAPEROPT_a4 = -D latex_paper_size=a4 PAPEROPT_letter = -D latex_paper_size=letter ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @echo " json to make JSON files" @echo " htmlhelp to make HTML files and a HTML help project" @echo " qthelp to make HTML files and a qthelp project" @echo " devhelp to make HTML files and a Devhelp project" @echo " epub to make an epub" @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" @echo " latexpdf to make LaTeX files and run them through pdflatex" @echo " text to make text files" @echo " man to make manual pages" @echo " texinfo to make Texinfo files" @echo " info to make Texinfo files and run them through makeinfo" @echo " gettext to make PO message catalogs" @echo " changes to make an overview of all changed/added/deprecated items" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" clean: -rm -rf $(BUILDDIR)/* html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." dirhtml: $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." singlehtml: $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml @echo @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." pickle: $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle @echo @echo "Build finished; now you can process the pickle files." json: $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json @echo @echo "Build finished; now you can process the JSON files." htmlhelp: $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp @echo @echo "Build finished; now you can run HTML Help Workshop with the" \ ".hhp project file in $(BUILDDIR)/htmlhelp." qthelp: $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp @echo @echo "Build finished; now you can run "qcollectiongenerator" with the" \ ".qhcp project file in $(BUILDDIR)/qthelp, like this:" @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/dh-virtualenv.qhcp" @echo "To view the help file:" @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/dh-virtualenv.qhc" devhelp: $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp @echo @echo "Build finished." @echo "To view the help file:" @echo "# mkdir -p $$HOME/.local/share/devhelp/dh-virtualenv" @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/dh-virtualenv" @echo "# devhelp" epub: $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub @echo @echo "Build finished. The epub file is in $(BUILDDIR)/epub." latex: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." @echo "Run \`make' in that directory to run these through (pdf)latex" \ "(use \`make latexpdf' here to do that automatically)." latexpdf: $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex @echo "Running LaTeX files through pdflatex..." $(MAKE) -C $(BUILDDIR)/latex all-pdf @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." text: $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text @echo @echo "Build finished. The text files are in $(BUILDDIR)/text." man: $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man @echo @echo "Build finished. The manual pages are in $(BUILDDIR)/man." texinfo: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." @echo "Run \`make' in that directory to run these through makeinfo" \ "(use \`make info' here to do that automatically)." info: $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo @echo "Running Texinfo files through makeinfo..." make -C $(BUILDDIR)/texinfo info @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." gettext: $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale @echo @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." changes: $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes @echo @echo "The overview file is in $(BUILDDIR)/changes." linkcheck: $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck @echo @echo "Link check complete; look for any errors in the above output " \ "or in $(BUILDDIR)/linkcheck/output.txt." doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." doc/conf.py000066400000000000000000000172001264047630100131250ustar00rootroot00000000000000# -*- coding: utf-8 -*- # # dh-virtualenv documentation build configuration file, created by # sphinx-quickstart on Wed Feb 20 17:29:43 2013. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import sys, os # 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 = [] # 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'dh-virtualenv' copyright = u'2013-2014 Spotify AB' # 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 = '0.11' # The full version, including alpha/beta/rc tags. release = '0.11' # 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 = ['_build'] # 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. html_theme = 'default' # 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 # " v documentation". #html_title = None # A shorter title for the navigation bar. Default is the same as html_title. #html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. #html_logo = None # 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 = None # 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 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 = 'dh-virtualenvdoc' # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). #'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). #'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ('index', 'dh-virtualenv.tex', u'dh-virtualenv Documentation', u'Spotify AB', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None # 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 # Documents to append as an appendix to all manuals. #latex_appendices = [] # If false, no module index is generated. #latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'dh-virtualenv', u'dh-virtualenv Documentation', [u'Spotify AB'], 1) ] # If true, show URL addresses after external links. #man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ('index', 'dh-virtualenv', u'dh-virtualenv Documentation', u'Spotify AB', 'dh-virtualenv', 'Debian packaging sequence for Python virtualenvs.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. #texinfo_appendices = [] # If false, no module index is generated. #texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. #texinfo_show_urls = 'footnote' doc/dh_virtualenv.1.rst000066400000000000000000000034371264047630100154000ustar00rootroot00000000000000============= dh-virtualenv ============= ------------------------------------------------------ deploy a Python package in a self-contained virtualenv ------------------------------------------------------ :Author: Jyrki Pulliainen / Spotify AB :Copyright: Copyright (C) 2013, Spotify AB. Licensed under the GNU General Public License version 2 or later :Manual section: 1 :Manual group: DebHelper SYNOPSIS ======== **dh_virtualenv** [*OPTIONS*] DESCRIPTION =========== ``dh-virtualenv`` is a tool that aims to combine Debian packaging with self-contained virtualenv based Python deployments. To do this, the package extends debhelper's sequence by providing a new command in sequence, ``dh_virtualenv``, which effectively replaces following commands from the sequence: * ``dh_auto_install`` * ``dh_python2`` * ``dh_pycentral`` * ``dh_pysupport`` In the sequence the ``dh_virtualenv`` is inserted right after ``dh_perl``. OPTIONS ======= -p PACKAGE, --package=PACKAGE Act on the package named PACKAGE -N PACKAGE, --no-package=PACKAGE Do not act on the specified PACKAGE -v, --verbose Turn on verbose mode. --extra-index-url Pass extra index URL to pip --preinstall=PACKAGE Preinstall a PACKAGE before running pip. --extra-pip-arg Extra arg for the pip executable. --pypi-url Base URL for PyPI server. --setuptools Use setuptools instead of distribute. QUICK GUIDE FOR MAINTAINERS =========================== 1. Build depend on `python` or `python-all` and `dh-virtualenv` 2. Add `${python:Depends}` to Depends 3. Add `python-virtualenv` to dh's `--with` option SEE ALSO ======== Online documentation can be found at http://dh-virtualenv.readthedocs.org/en/latest. This package should also ship with documentation under `/usr/share/doc/dh-virtualenv`. doc/index.rst000066400000000000000000000007311264047630100134700ustar00rootroot00000000000000.. dh-virtualenv documentation master file, created by sphinx-quickstart on Wed Feb 20 17:29:43 2013. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to dh-virtualenv's documentation! ========================================= Contents: .. toctree:: :maxdepth: 2 info tutorial usage Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` doc/info.rst000066400000000000000000000066631264047630100133260ustar00rootroot00000000000000======================= What is dh-virtualenv ======================= ``dh-virtualenv`` is a tool that aims to combine Debian packaging with self-contained virtualenv based Python deployments. To do this, the package extends debhelper's sequence by providing a new command in sequence, ``dh_virtualenv``, which effectively replaces following commands from the sequence: * ``dh_auto_install`` * ``dh_python2`` * ``dh_pycentral`` * ``dh_pysupport`` In the sequence the ``dh_virtualenv`` is inserted right after ``dh_perl``. =========== Changelog =========== Following list contains most notable changes by version. For full list consult the git history of the project. 0.11 ==== * Allow passing explicit filename for `requirements.txt` using `--requirements` option. Thanks to `Eric Larson `_ for implementing! * Ensure that venv is configured before starting any daemons. Thanks to `Chris Lamb `_ for fixing this! * Make sure `fix_activate_path` updates all activate scripts. Thanks to `walrusVision `_ for fixing this! 0.10 ==== * **Backwards incompatible** Fix installation using the built-in virtual environment on 3.4. This might break installation on Python versions prior to 3.4 when using `--builtin-venv` flag. Thanks to `Elonen `_ for fixing! * Honor ``DH_VIRTUALENV_INSTALL_ROOT`` in build system. Thanks to `Ludwig Hähne `_ for implementing! * Allow overriding virtualenv arguments by using the ``DH_VIRTUALENV_ARGUMENTS`` environment variable when using the build system. Thanks to `Ludwig Hähne `_ for implementing! * Add option to skip installation of the actual project. In other words using ``--skip-install`` installs only the dependencies of the project found in requirements.txt. Thanks to `Phillip O'Donnell `_ for implementing! * Support custom installation suffix instead of the package name via ``--install-suffix``. Thanks to `Phillip O'Donnell `_ for implementing! 0.9 === * Support using system packages via a command line flag ``--use-system-packages``. Thanks to `Wes Mason `_ for implementing this feature! * Introduce a new, experimental, more modular build system. See the :doc:`usage` for documentation. * Respect the ``DEB_NO_CHECK`` environment variable. 0.8 === * Support for running triggers upon host interpreter update. This new feature makes it possible to upgrade the host Python interpreter and avoid breakage of all the virtualenvs installed with virtualenv. For usage, see the the :doc:`tutorial`. Huge thanks to `Jürgen Hermann `_ for implementing this long wanted feature! * Add support for the built-in ``venv`` module. Thanks to `Petri Lehtinen `_! * Allow custom ``pip`` flags to be passed via the ``--extra-pip-args`` flag. Thanks to `@labeneator `_ for the feature. 0.7 === * **Backwards incompatible** Support running tests. This change breaks builds that use distutils. For those cases a flag ``--no-test`` needs to be passed. * Add tutorial to documentation * Don't crash on debbuild parameters ``-i`` and ``-a`` * Support custom source directory (debhelper's flag ``-D``) 0.6 === First public release of *dh-virtualenv* doc/make.bat000066400000000000000000000117661264047630100132460ustar00rootroot00000000000000@ECHO OFF REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set BUILDDIR=_build set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . set I18NSPHINXOPTS=%SPHINXOPTS% . if NOT "%PAPER%" == "" ( set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% ) if "%1" == "" goto help if "%1" == "help" ( :help echo.Please use `make ^` where ^ is one of echo. html to make standalone HTML files echo. dirhtml to make HTML files named index.html in directories echo. singlehtml to make a single large HTML file echo. pickle to make pickle files echo. json to make JSON files echo. htmlhelp to make HTML files and a HTML help project echo. qthelp to make HTML files and a qthelp project echo. devhelp to make HTML files and a Devhelp project echo. epub to make an epub echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter echo. text to make text files echo. man to make manual pages echo. texinfo to make Texinfo files echo. gettext to make PO message catalogs echo. changes to make an overview over all changed/added/deprecated items echo. linkcheck to check all external links for integrity echo. doctest to run all doctests embedded in the documentation if enabled goto end ) if "%1" == "clean" ( for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i del /q /s %BUILDDIR%\* goto end ) if "%1" == "html" ( %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/html. goto end ) if "%1" == "dirhtml" ( %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. goto end ) if "%1" == "singlehtml" ( %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml if errorlevel 1 exit /b 1 echo. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. goto end ) if "%1" == "pickle" ( %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the pickle files. goto end ) if "%1" == "json" ( %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can process the JSON files. goto end ) if "%1" == "htmlhelp" ( %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run HTML Help Workshop with the ^ .hhp project file in %BUILDDIR%/htmlhelp. goto end ) if "%1" == "qthelp" ( %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp if errorlevel 1 exit /b 1 echo. echo.Build finished; now you can run "qcollectiongenerator" with the ^ .qhcp project file in %BUILDDIR%/qthelp, like this: echo.^> qcollectiongenerator %BUILDDIR%\qthelp\dh-virtualenv.qhcp echo.To view the help file: echo.^> assistant -collectionFile %BUILDDIR%\qthelp\dh-virtualenv.ghc goto end ) if "%1" == "devhelp" ( %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp if errorlevel 1 exit /b 1 echo. echo.Build finished. goto end ) if "%1" == "epub" ( %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub if errorlevel 1 exit /b 1 echo. echo.Build finished. The epub file is in %BUILDDIR%/epub. goto end ) if "%1" == "latex" ( %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex if errorlevel 1 exit /b 1 echo. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. goto end ) if "%1" == "text" ( %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text if errorlevel 1 exit /b 1 echo. echo.Build finished. The text files are in %BUILDDIR%/text. goto end ) if "%1" == "man" ( %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man if errorlevel 1 exit /b 1 echo. echo.Build finished. The manual pages are in %BUILDDIR%/man. goto end ) if "%1" == "texinfo" ( %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo if errorlevel 1 exit /b 1 echo. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. goto end ) if "%1" == "gettext" ( %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale if errorlevel 1 exit /b 1 echo. echo.Build finished. The message catalogs are in %BUILDDIR%/locale. goto end ) if "%1" == "changes" ( %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes if errorlevel 1 exit /b 1 echo. echo.The overview file is in %BUILDDIR%/changes. goto end ) if "%1" == "linkcheck" ( %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck if errorlevel 1 exit /b 1 echo. echo.Link check complete; look for any errors in the above output ^ or in %BUILDDIR%/linkcheck/output.txt. goto end ) if "%1" == "doctest" ( %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest if errorlevel 1 exit /b 1 echo. echo.Testing of doctests in the sources finished, look at the ^ results in %BUILDDIR%/doctest/output.txt. goto end ) :end doc/tutorial.rst000066400000000000000000000123641264047630100142310ustar00rootroot00000000000000======== Tutorial ======== This tutorial will guide you through setting up your first project using *dh-virtualenv*. Having some knowledge on how Debian packages work won't hurt, but it is not necessary a mandatory requirement. You also need some basic build tools, so it is recommended to install `build-essential` and `devscripts` packages. Step 1: Install dh-virtualenv ============================= In order to use it, you need to install the *dh-virtualenv*. If you run Debian Jessie (testing), Debian Sid (unstable) or Ubuntu 14.04 LTS (Trusty), you can install *dh-virtualenv* simply with *apt-get*: .. code-block:: bash sudo apt-get install dh-virtualenv For more recent packages there is [an unofficial PPA maintained](https://launchpad.net/~spotify-jyrki/+archive/ubuntu/dh-virtualenv) by the author. For other systems the only way is to build and install it yourself. Steps to do that, after you have cloned the repository are: .. code-block:: bash sudo apt-get install devscripts python-virtualenv git equivs # Install needed packages git clone https://github.com/spotify/dh-virtualenv.git # Clone Git repository cd dh-virtualenv # Move into the repository sudo mk-build-deps -ri # This will install build dependencies dpkg-buildpackage -us -uc -b # Build the *dh-virtualenv* package # and finally, install it (you might have to solve some # dependencies when doing this): sudo dpkg -i ../dh-virtualenv_.deb Step 2: Setup the Debian packaging ================================== Grab your favourite Python project you want to use *dh-virtualenv* with and set it up. Only requirement is that your project has a somewhat sane ``setup.py`` and requirements listed in a ``requirements.txt`` file. Note however that defining any requirements is not mandatory. Next you need to define the Debian packaging for your software. To do this, create a directory called ``debian`` in the project root. To be able to build a debian package, a few files are needed. First, we need to define the compatibility level of the project. For this, do: .. code-block:: bash echo "9" > debian/compat The 9 is a magic number for latest compatibility level, but we don't need to worry about that. Next we need a file that tells what our project is about, a file called ``control``. Enter a following ``debian/control`` file: .. code-block:: control Source: my-awesome-python-software Section: python Priority: extra Maintainer: Matt Maintainer Build-Depends: debhelper (>= 9), python, dh-virtualenv (>= 0.8) Standards-Version: 3.9.5 Package: my-awesome-python-software Architecture: any Pre-Depends: dpkg (>= 1.16.1), python2.7 | python2.6, ${misc:Pre-Depends} Depends: ${python:Depends}, ${misc:Depends} Description: really neat package! second line can contain extra information about it. The ``control`` file is used to define the build dependencies, so if you are building a package that requires for example ``lxml``, make sure you define ``libxml2-dev`` in *Build-Depends* etc. *Depends* in the lower section is used to define run-time dependencies. Following the example above, in case of lxml you would add ``libxml2`` in to the *Depends* field. To help keeping your installed virtualenv in sync with the host's Python interpreter in case of updates, create a file named ``debian/«pkgname».triggers``, where ``«pkgname»`` is what you named your package in the ``control`` file. It triggers a special script whenever the Python binary changes; don't worry, that script is provided by ``dh-virtualenv`` automatically. .. code-block:: «pkgname».triggers # Register interest in Python interpreter changes (Python 2 for now); and # don't make the Python package dependent on the virtualenv package # processing (noawait) interest-noawait /usr/bin/python2.6 interest-noawait /usr/bin/python2.7 # Also provide a symbolic trigger for all dh-virtualenv packages interest dh-virtualenv-interpreter-update Note that if you provide a custom ``postinst`` script with your package, then don't forget to put the ``#DEBHELPER#`` marker into it, else the trigger script will be missing. Next, we need a changelog file. It is basically a documentation of changes in your package plus the source for version number for Debian package builder. Here's a short sample changelog to be entered in ``debian/changelog``: :: my-awesome-python-software (0.1-1) unstable; urgency=low * Initial public release -- Matt Maintainer Fri, 01 Nov 2013 17:00:00 +0200 You don't need to create this file by hand, a handy tool called ``dch`` exists for entering new changelog entries. Now, last bit is left, which is the ``debian/rules`` file. This file is basically a Makefile that Debian uses to build the package. Content for that is fairly straightforward: .. code-block:: make #!/usr/bin/make -f %: dh $@ --with python-virtualenv And there we go, debianization of your new package is ready! Step 3: Build your project ========================== Now you can just build your project by running ``dpkg-buildpackage -us -uc``. Enjoy your newly baked *dh-virtualenv* backed project! :) doc/usage.rst000066400000000000000000000215271264047630100134730ustar00rootroot00000000000000====================================== Building packages with dh-virtualenv ====================================== Building packages with *dh-virtualenv* is relatively easy to start with but it also supports lot of customization to fit in your general needs. By default, *dh-virtualenv* installs your packages under ``/usr/share/python/``. The package name is provided by the ``debian/control`` file. To use an alternative install prefix, add a line like .. code-block:: make export DH_VIRTUALENV_INSTALL_ROOT= to the top of your ``debian/rules`` file. dh_virtualenv will use DH_VIRTUALENV_INSTALL_ROOT instead of ``/usr/share/python`` when it constructs the install path. To use an install suffix other than the package name, call the ``dh_virtualenv`` command using with the ``--install-suffix`` command line option. See Advanced Usage for further information on passing options. Simple usecase ============== To signal debhelper to use *dh-virtualenv* for building your package, you need to pass ``--with python-virtualenv`` to debhelper sequencer. In a nutshell, the simplest ``debian/rules`` file to build using *dh-virtualenv* looks like this: .. code-block:: make #!/usr/bin/make -f %: dh $@ --with python-virtualenv However, the tool makes a few assumptions of your project's structure: * For installing requirements, you need to have a file called ``requirements.txt`` in the root directory of your project. The requirements file is not mandatory. * The project must have a ``setup.py`` file in the root of the project. Sequencer will run ``setup.py install`` to install the package inside the virtualenv. After these are place, you can just build the package with your favorite tool! Command line options ==================== To change the default behavior the ``dh_virtualenv`` command accepts a few command line options: .. cmdoption:: -p , --package Act on the package named ** .. cmdoption:: -N , --no-package Do not act on the specified package .. cmdoption:: -v, --verbose Turn on verbose mode. This has a few effects: it sets root logger level to ``DEBUG`` and passes verbose flag to ``pip`` when installing packages. This can also be provided using the standard ``DH_VERBOSE`` environment variable. .. cmdoption:: --install-suffix Override virtualenv installation suffix. The suffix is appended to ``/usr/share/python``, or the ``DH_VIRTUALENV_INSTALL_ROOT`` environment variable if specified, to construct the installation path. .. cmdoption:: --extra-index-url Use extra index url ** when running ``pip`` to install packages. This can be provided multiple times to pass multiple URLs to ``pip``. This is useful if you for example have a private Python Package Index. .. cmdoption:: --preinstall Package to install before processing the requirements. This flag can be used to provide a package that is installed by ``pip`` before processing requirements file. This is handy if you need to install for example a custom setup script or other packages needed to parse ``setup.py``. This flag can be provided multiple times to pass multiple packages for pre-install. .. cmdoption:: --pypi-url Base URL of the PyPI server. This flag can be used to pass in a custom URL to a PyPI mirror. It's useful if you for example have an internal mirror of the PyPI or you run a special instance that only exposes selected packages of PyPI. If this is not provided, the default will be whatever ``pip`` uses as default (usually ``http://pypi.python.org/simple``). .. cmdoption:: --extra-pip-arg Extra parameters to pass to the pip executable. This is useful if you need to change the behaviour of pip during the packaging process. You can use this flag multiple times to pass in different pip flags. As an example passing in --extra-pip-arg "--no-compile" to the override_dh_virtualenv section of the debian/rules file will disable the generation of pyc files. .. cmdoption:: --requirements Use a different requirements file when installing. Some packages such as `pbr `_ expect the ``requirements.txt`` file to be a simple list of requirements that can be copied verbatim into the ``install_requires`` list. This command option allows specifying a different ``requirements.txt`` file that may include pip specific flags such as ``-i``, ``-r-`` and ``-e``. .. cmdoption:: --setuptools Use setuptools instead of distribute in the virtualenv .. cmdoption:: --no-test Skip running ``python setup.py test`` after dependencies and the package is installed. This is useful if the Python code is packaged using distutils and not setuptools. .. cmdoption:: --python Use a specific Python interpreter found in ``path`` as the interpreter for the virtualenv. Default is to use the system default, usually ``/usr/bin/python``. .. cmdoption:: --builtin-venv Enable the use of the build-in ``venv`` module, i.e. use ``python -m venv`` to create the virtualenv. For this to work, requires Python 3.4 or later to be used, e.g. by using the option ``--python /usr/bin/python3.4``. (Python 3.3 has the ``venv`` module, but virtualenvs created with Python 3.3 are not bootstrapped with setuptools or pip.) .. cmdoption:: -S, --use-system-packages Enable the use of system site-packages in the created virtualenv by passing the ``--system-site-packages`` flag to ``virtualenv``. .. cmdoption:: --skip-install Skip running ``pip install .`` after dependencies have been installed. This will result in anything specified in setup.py being ignored. If this package is intended to install a virtualenv and a program that uses the supplied virtualenv, it is up to the user to ensure that if setup.py exists, any installation logic or dependencies contained therein are handled. This option is useful for web application deployments where the package is expected contain the virtual environment to support an application which itself may be installed via some other means -- typically, by the packages ``./debian/.install`` file, possibly into a directory structure unrelated to the location of the virtual environment. Advanced usage ============== To provide command line options to ``dh_virtualenv`` sequence the override mechanism of the debhelper is the best tool. Following ``debian/rules`` will provide *http://example.com* as additional Python Package Index URI: .. code-block:: make #!/usr/bin/make -f %: dh $@ --with python-virtualenv override_dh_virtualenv: dh_virtualenv --extra-index-url http://example.com Experimental buildsystem support ================================ **Important**: Following chapters describe a completely experimental functionality of dh-virtualenv. Starting with version 0.9 of dh-virtualenv, there is a buildsystem alternative. The main difference in use is that instead of the ``--with python-virtualenv`` option, ``--buildsystem=dh_virtualenv`` is passed to debhelper. The ``debian rules`` file should look like this: .. code-block:: make #!/usr/bin/make -f %: dh $@ --buildsystem=dh_virtualenv Using the buildsystem instead of the part of the sequence (in other words, instead of the ``--with python-virtualenv``) one can get more flexibility into the build process. Flexibility comes from the fact that buildsystem will have individual steps for configure, build, test and install and those can be overridden by adding ``override_dh_auto_`` target into the ``debian/rules`` file. For example: .. code-block:: make #!/usr/bin/make -f %: dh $@ --buildsystem=dh_virtualenv override_dh_auto_test: py.test test/ In addition the separation of build and install steps makes it possible to use ``debian/install`` files to include built files into the Debian package. This is not possible with the sequencer addition. The build system honors the ``DH_VIRTUALENV_INSTALL_ROOT`` environment variable. Arguments can be passed to virtualenv by setting ``DH_VIRTUALENV_ARGUMENTS``. For example: .. code-block:: make export DH_VIRTUALENV_ARGUMENTS=--no-site-packages --always-copy The default is to create the virtual environment with ``--no-site-packages``. Known incompabilities of the buildsystem ---------------------------------------- This section defines the known incompabilities with the sequencer approach. There are no guarantees that these all get addressed, but most of them, if not all, probably will. * No custom Python interpreter supported * ``Pyvenv`` of Python 3.x is not supported * No custom arguments outside requirements.txt can be passed to ``pip`` lib/000077500000000000000000000000001264047630100116275ustar00rootroot00000000000000lib/Debian/000077500000000000000000000000001264047630100130115ustar00rootroot00000000000000lib/Debian/Debhelper/000077500000000000000000000000001264047630100147035ustar00rootroot00000000000000lib/Debian/Debhelper/Buildsystem/000077500000000000000000000000001264047630100172075ustar00rootroot00000000000000lib/Debian/Debhelper/Buildsystem/dh_virtualenv.pm000066400000000000000000000066651264047630100224340ustar00rootroot00000000000000package Debian::Debhelper::Buildsystem::dh_virtualenv; use strict; use base 'Debian::Debhelper::Buildsystem'; use Debian::Debhelper::Dh_Lib; use File::Spec; use Cwd; sub DESCRIPTION { 'Python Virtualenv'; } sub DEFAULT_BUILD_DIRECTORY { my $this=shift; return $this->canonpath($this->get_sourcepath("build")); } sub check_auto_buildable { my $this=shift; return -e $this->get_sourcepath("setup.py") ? 1 : 0; } sub new { my $class = shift; my $this = $class->SUPER::new(@_); $this->prefer_out_of_source_building(); return $this; } sub get_install_root { my $prefix = "/usr/share/python"; if (defined $ENV{DH_VIRTUALENV_INSTALL_ROOT}) { $prefix = $ENV{DH_VIRTUALENV_INSTALL_ROOT}; } return $prefix; } sub get_venv_builddir { my $this = shift; my $builddir = $this->get_builddir(); my $sourcepackage = $this->sourcepackage(); my $prefix = $this->get_install_root(); return "$builddir$prefix/$sourcepackage"; } sub get_exec { my $this = shift; my $executable = shift; my $builddir = $this->get_venv_builddir(); return Cwd::abs_path("$builddir/bin/$executable"); } sub get_python { my $this = shift; return $this->get_exec("python"); } sub get_pip { my $this = shift; return $this->get_exec("pip"); } sub configure { my $this = shift; doit('mkdir', '-p', $this->get_venv_builddir()); } sub build { my $this = shift; my $sourcedir = $this->get_sourcedir(); my $builddir = $this->get_venv_builddir(); my @params = ('--no-site-packages'); if (defined $ENV{DH_VIRTUALENV_ARGUMENTS}) { @params = split(' ', $ENV{DH_VIRTUALENV_ARGUMENTS}); } $this->doit_in_builddir( 'virtualenv', @params, Cwd::abs_path($builddir)); my $python = $this->get_python(); my $pip = $this->get_pip(); $this->doit_in_sourcedir( $python, $pip, 'install', '-r', 'requirements.txt'); $this->doit_in_sourcedir( $python, $pip, 'install', '.'); } sub test { my $this = shift; my $python = $this->get_python(); $this->doit_in_sourcedir( $python, 'setup.py', 'test'); } sub install { my $this = shift; my $destdir = shift; my $pip = $this->get_pip(); my $python = $this->get_python(); my $sourcepackage = $this->sourcepackage(); my $venv = $this->get_venv_builddir(); my $prefix = $this->get_install_root(); # Before we copy files, let's make the symlinks in the 'usr/local' # relative to the build path. my @files_in_local = <"$venv/local/*">; foreach (@files_in_local) { if ( -l $_ ) { my $target = readlink; my $relpath = File::Spec->abs2rel($target, "$venv/local"); my $basename = Debian::Debhelper::Dh_Lib->basename($_); unlink; symlink($relpath, $_); } } $this->doit_in_builddir('mkdir', '-p', $destdir); $this->doit_in_builddir('cp', '-r', '-T', '.', $destdir); my $new_python = "$prefix/$sourcepackage/bin/python"; # Fix shebangs so that we use the Python in the final location # instead of the Python in the build directory my @binaries = <"$destdir$prefix/$sourcepackage/bin/*">; { local $^I = q{}; local @ARGV = grep { -T } @binaries; while ( <> ) { s|^#!.*bin/(env )?python|#!$new_python|; print; } } } sub clean { my $this = shift; $this->rmdir_builddir(); } 1 lib/Debian/Debhelper/Sequence/000077500000000000000000000000001264047630100164535ustar00rootroot00000000000000lib/Debian/Debhelper/Sequence/python_virtualenv.pm000066400000000000000000000026271264047630100226200ustar00rootroot00000000000000#! /usr/bin/perl # debhelper sequence for wrapping packages inside virtualenvs # Copyright (c) Spotify AB 2013 # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . use warnings; use strict; use Debian::Debhelper::Dh_Lib; insert_before("dh_installinit", "dh_virtualenv"); # dh_auto_test can cause system python to run 'python setup.py test', # which will break due missing dependencies. remove_command("dh_auto_test"); # dh_auto_build causes system python to run 'python setup.py build' # which is unnecessary as we will run that inside the virtualenv # anyway remove_command("dh_auto_build"); # Same for dh_auto_install and dh_auto_clean remove_command("dh_auto_install"); remove_command("dh_auto_clean"); remove_command("dh_python2"); remove_command("dh_pycentral"); remove_command("dh_pysupport"); 1 setup.cfg000066400000000000000000000001651264047630100127040ustar00rootroot00000000000000[build_sphinx] source-dir = doc build-dir = doc/_build all-files = 1 [upload_sphinx] upload-dir = doc/_build/html setup.py000077500000000000000000000027611264047630100126040ustar00rootroot00000000000000#! /usr/bin/env python # -*- coding: utf-8 -*- # Copyright (c) 2013 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . from setuptools import setup setup(name='dh_virtualenv', version='0.11', author=u'Jyrki Pulliainen', author_email='jyrki@spotify.com', url='https://github.com/spotify/dh-virtualenv', description='Debian packaging sequence for Python virtualenvs.', license='GNU General Public License v2 or later', scripts=['bin/dh_virtualenv'], packages=['dh_virtualenv'], classifiers=[ 'Intended Audience :: Developers', 'Intended Audience :: System Administrators', 'License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)', 'Topic :: Software Development :: Build Tools', 'Topic :: System :: Installation/Setup', 'Topic :: Utilities', ]) test/000077500000000000000000000000001264047630100120405ustar00rootroot00000000000000test/test_cmdline.py000066400000000000000000000050621264047630100150670ustar00rootroot00000000000000#!/usr/bin/env python # -*- coding: utf-8 -*- # Copyright (c) 2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . import os from dh_virtualenv import cmdline from mock import patch from nose.tools import eq_ @patch.object(cmdline.DebhelperOptionParser, 'error') def test_unknown_argument_is_error(error_mock): parser = cmdline.DebhelperOptionParser(usage='foo') parser.parse_args(['-f']) eq_(1, error_mock.call_count) def test_test_debhelper_option_parsing(): parser = cmdline.DebhelperOptionParser() parser.add_option('--sourcedirectory') opts, args = parser.parse_args(['-O--sourcedirectory', '/tmp']) eq_('/tmp', opts.sourcedirectory) eq_([], args) def test_parser_picks_up_DH_OPTIONS_from_environ(): os.environ['DH_OPTIONS'] = '--sourcedirectory=/tmp/' parser = cmdline.get_default_parser() opts, args = parser.parse_args() eq_('/tmp/', opts.sourcedirectory) del os.environ['DH_OPTIONS'] def test_get_default_parser(): parser = cmdline.get_default_parser() opts, args = parser.parse_args([ '-O--sourcedirectory', '/tmp/foo', '--extra-index-url', 'http://example.com' ]) eq_('/tmp/foo', opts.sourcedirectory) eq_(['http://example.com'], opts.extra_index_url) def test_that_default_test_option_should_be_true(): parser = cmdline.get_default_parser() opts, args = parser.parse_args() eq_(True, opts.test) def test_that_test_option_can_be_false(): parser = cmdline.get_default_parser() opts, args = parser.parse_args(['--no-test']) eq_(False, opts.test) def test_that_default_use_system_packages_option_should_be_false(): parser = cmdline.get_default_parser() opts, args = parser.parse_args() eq_(False, opts.use_system_packages) def test_that_use_system_packages_option_can_be_true(): parser = cmdline.get_default_parser() opts, args = parser.parse_args(['--use-system-packages']) eq_(True, opts.use_system_packages) test/test_deployment.py000066400000000000000000000317541264047630100156430ustar00rootroot00000000000000# -*- coding: utf-8 -*- # Copyright (c) 2013-2014 Spotify AB # This file is part of dh-virtualenv. # dh-virtualenv 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 2 of the # License, or (at your option) any later version. # dh-virtualenv 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 dh-virtualenv. If not, see # . import functools import os import shutil import tempfile import textwrap from mock import patch, call from nose.tools import eq_ from dh_virtualenv import Deployment from dh_virtualenv.cmdline import get_default_parser PY_CMD = os.path.abspath('debian/test/usr/share/python/test/bin/python') PIP_CMD = os.path.abspath('debian/test/usr/share/python/test/bin/pip') class FakeTemporaryFile(object): name = 'foo' def temporary_dir(fn): """Pass a temporary directory to the fn. This method makes sure it is destroyed at the end """ @functools.wraps(fn) def _inner(*args, **kwargs): try: tempdir = tempfile.mkdtemp() return fn(tempdir, *args, **kwargs) finally: shutil.rmtree(tempdir) return _inner def test_shebangs_fix(): deployment = Deployment('test') temp = tempfile.NamedTemporaryFile() # We cheat here a little. The fix_shebangs walks through the # project directory, however we can just point to a single # file, as the underlying mechanism is just grep -r. deployment.bin_dir = temp.name with open(temp.name, 'w') as f: f.write('#!/usr/bin/python\n') deployment.fix_shebangs() with open(temp.name) as f: eq_('#!/usr/share/python/test/bin/python\n', f.read()) with open(temp.name, 'w') as f: f.write('#!/usr/bin/env python\n') deployment.fix_shebangs() with open(temp.name) as f: eq_('#!/usr/share/python/test/bin/python\n', f.readline()) def test_shebangs_fix_overridden_root(): os.environ['DH_VIRTUALENV_INSTALL_ROOT'] = 'foo' deployment = Deployment('test') temp = tempfile.NamedTemporaryFile() # We cheat here a little. The fix_shebangs walks through the # project directory, however we can just point to a single # file, as the underlying mechanism is just grep -r. deployment.bin_dir = temp.name with open(temp.name, 'w') as f: f.write('#!/usr/bin/python\n') deployment.fix_shebangs() with open(temp.name) as f: eq_('#!foo/test/bin/python\n', f.read()) with open(temp.name, 'w') as f: f.write('#!/usr/bin/env python\n') deployment.fix_shebangs() with open(temp.name) as f: eq_('#!foo/test/bin/python\n', f.readline()) del os.environ['DH_VIRTUALENV_INSTALL_ROOT'] @patch('os.path.exists', lambda x: False) @patch('subprocess.check_call') def test_install_dependencies_with_no_requirements(callmock): d = Deployment('test') d.pip_prefix = ['pip', 'install'] d.install_dependencies() callmock.assert_has_calls([]) @patch('os.path.exists', lambda x: True) @patch('subprocess.check_call') def test_install_dependencies_with_requirements(callmock): d = Deployment('test') d.pip_prefix = ['pip', 'install'] d.install_dependencies() callmock.assert_called_with( ['pip', 'install', '-r', './requirements.txt']) @patch('subprocess.check_call') def test_install_dependencies_with_preinstall(callmock): d = Deployment('test', preinstall=['foobar']) d.pip_prefix = ['pip', 'install'] d.install_dependencies() callmock.assert_called_with( ['pip', 'install', 'foobar']) @patch('os.path.exists', lambda x: True) @patch('subprocess.check_call') def test_install_dependencies_with_preinstall_with_requirements(callmock): d = Deployment('test', preinstall=['foobar']) d.pip_prefix = ['pip', 'install'] d.install_dependencies() callmock.assert_has_calls([ call(['pip', 'install', 'foobar']), call(['pip', 'install', '-r', './requirements.txt']) ]) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv(callmock): d = Deployment('test') d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_verbose(callmock): d = Deployment('test', verbose=True) d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', '--verbose', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, '-v', 'install', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_extra_urls(callmock): d = Deployment('test', extra_urls=['foo', 'bar']) d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--extra-index-url=foo', '--extra-index-url=bar', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_custom_index_url(callmock): d = Deployment('test', extra_urls=['foo', 'bar'], pypi_url='http://example.com/simple') d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--pypi-url=http://example.com/simple', '--extra-index-url=foo', '--extra-index-url=bar', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_extra_pip_arg(callmock): d = Deployment('test', extra_pip_arg=['--no-compile']) d.create_virtualenv() d.install_dependencies() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo'), '--no-compile'], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_setuptools(callmock): d = Deployment('test', setuptools=True) d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', '--setuptools', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_create_venv_with_system_packages(callmock): d = Deployment('test', use_system_packages=True) d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--system-site-packages', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_venv_with_custom_python(callmock): d = Deployment('test', python='/tmp/python') d.create_virtualenv() eq_('debian/test/usr/share/python/test', d.package_dir) callmock.assert_called_with(['virtualenv', '--no-site-packages', '--python', '/tmp/python', 'debian/test/usr/share/python/test']) eq_([PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo')], d.pip_prefix) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_install_package(callmock): d = Deployment('test') d.bin_dir = 'derp' d.pip_prefix = ['derp/python', 'derp/pip'] d.install_package() callmock.assert_called_with([ 'derp/python', 'derp/pip', '.', ], cwd=os.getcwd()) def test_fix_activate_path(): deployment = Deployment('test') temp = tempfile.NamedTemporaryFile() with open(temp.name, 'w') as fh: fh.write(textwrap.dedent(""" other things VIRTUAL_ENV="/this/path/is/wrong/and/longer/than/new/path" more other things """)) expected = textwrap.dedent(""" other things VIRTUAL_ENV="/usr/share/python/test" more other things """) with patch('dh_virtualenv.deployment.os.path.join', return_value=temp.name): deployment.fix_activate_path() with open(temp.name) as fh: eq_(expected, temp.read()) @patch('os.path.exists', lambda x: True) @patch('tempfile.NamedTemporaryFile', FakeTemporaryFile) @patch('subprocess.check_call') def test_custom_src_dir(callmock): d = Deployment('test') d.pip_prefix = ['pip', 'install'] d.sourcedirectory = 'root/srv/application' d.create_virtualenv() d.install_dependencies() callmock.assert_called_with([ PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo'), '-r', 'root/srv/application/requirements.txt'], ) d.install_package() callmock.assert_called_with([ PY_CMD, PIP_CMD, 'install', '--log=' + os.path.abspath('foo'), '.', ], cwd=os.path.abspath('root/srv/application')) @patch('os.path.exists', lambda *a: True) @patch('subprocess.check_call') def test_testrunner(callmock): d = Deployment('test') d.run_tests() callmock.assert_called_once_with([ PY_CMD, 'setup.py', 'test', ], cwd='.') @patch('os.path.exists', lambda *a: False) @patch('subprocess.check_call') def test_testrunner_setuppy_not_found(callmock): d = Deployment('test') d.run_tests() eq_(callmock.call_count, 0) def test_deployment_from_options(): options, _ = get_default_parser().parse_args([ '--extra-index-url', 'http://example.com', '-O--pypi-url', 'http://example.org' ]) d = Deployment.from_options('foo', options) eq_(d.package, 'foo') eq_(d.pypi_url, 'http://example.org') eq_(d.extra_urls, ['http://example.com']) def test_deployment_from_options_with_verbose(): options, _ = get_default_parser().parse_args([ '--verbose' ]) d = Deployment.from_options('foo', options) eq_(d.package, 'foo') eq_(d.verbose, True) @patch('os.environ.get') def test_deployment_from_options_with_verbose_from_env(env_mock): env_mock.return_value = '1' options, _ = get_default_parser().parse_args([]) d = Deployment.from_options('foo', options) eq_(d.package, 'foo') eq_(d.verbose, True) @temporary_dir def test_fix_local_symlinks(deployment_dir): d = Deployment('testing') d.package_dir = deployment_dir local = os.path.join(deployment_dir, 'local') os.makedirs(local) target = os.path.join(deployment_dir, 'sometarget') symlink = os.path.join(local, 'symlink') os.symlink(target, symlink) d.fix_local_symlinks() eq_(os.readlink(symlink), '../sometarget') @temporary_dir def test_fix_local_symlinks_with_relative_links(deployment_dir): # Runs shouldn't ruin the already relative symlinks. d = Deployment('testing') d.package_dir = deployment_dir local = os.path.join(deployment_dir, 'local') os.makedirs(local) symlink = os.path.join(local, 'symlink') os.symlink('../target', symlink) d.fix_local_symlinks() eq_(os.readlink(symlink), '../target') @temporary_dir def test_fix_local_symlinks_does_not_blow_up_on_missing_local(deployment_dir): d = Deployment('testing') d.package_dir = deployment_dir d.fix_local_symlinks() travis-requirements.txt000066400000000000000000000001401264047630100156460ustar00rootroot00000000000000Jinja2==2.7.1 MarkupSafe==0.18 Pygments==1.6 Sphinx==1.2 docutils==0.11 mock==1.0.1 nose==1.3.0