diff options
Diffstat (limited to 'src/buildstream/plugins/elements/pip.py')
-rw-r--r-- | src/buildstream/plugins/elements/pip.py | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/buildstream/plugins/elements/pip.py b/src/buildstream/plugins/elements/pip.py new file mode 100644 index 000000000..4a9eefde1 --- /dev/null +++ b/src/buildstream/plugins/elements/pip.py @@ -0,0 +1,51 @@ +# +# Copyright (C) 2017 Mathieu Bridon +# +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2 of the License, or (at your option) any later version. +# +# This library 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 +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library. If not, see <http://www.gnu.org/licenses/>. +# +# Authors: +# Mathieu Bridon <bochecha@daitauha.fr> + +""" +pip - Pip build element +======================= +A :mod:`BuildElement <buildstream.buildelement>` implementation for installing +Python modules with pip + +The pip default configuration: + .. literalinclude:: ../../../src/buildstream/plugins/elements/pip.yaml + :language: yaml + +See :ref:`built-in functionality documentation <core_buildelement_builtins>` for +details on common configuration options for build elements. +""" + +from buildstream import BuildElement, SandboxFlags + + +# Element implementation for the 'pip' kind. +class PipElement(BuildElement): + # Supports virtual directories (required for remote execution) + BST_VIRTUAL_DIRECTORY = True + + # Enable command batching across prepare() and assemble() + def configure_sandbox(self, sandbox): + super().configure_sandbox(sandbox) + self.batch_prepare_assemble(SandboxFlags.ROOT_READ_ONLY, + collect=self.get_variable('install-root')) + + +# Plugin entry point +def setup(): + return PipElement |