Metadata-Version: 2.4
Name: bst-plugins-container
Version: 0.4.1
Summary: A collection of BuildStream plugins that are related to containers.
Author: BuildStream Developers
Author-email: dev@buildstream.apache.org
License: LGPL
Project-URL: Source, https://gitlab.com/BuildStream/bst-plugins-container
Project-URL: Documentation, https://buildstream.gitlab.io/bst-plugins-container/
Project-URL: Tracker, https://gitlab.com/BuildStream/bst-plugins-container/issues
Project-URL: Mailing List, https://lists.apache.org/list.html?dev@buildstream.apache.org
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.6
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE
Requires-Dist: requests
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

BuildStream Container Plugins
*****************************

.. image:: https://gitlab.com/BuildStream/bst-plugins-container/badges/master/pipeline.svg
   :target: https://gitlab.com/BuildStream/bst-plugins-container/commits/master

.. image:: https://img.shields.io/pypi/v/bst-plugins-container.svg
   :target: https://pypi.org/project/bst-plugins-container

.. image:: https://img.shields.io/pypi/pyversions/bst-plugins-container.svg
   :target: https://pypi.org/project/bst-plugins-container

.. image:: https://img.shields.io/badge/Documentation-yellow.svg?logo=gitlab&labelColor=grey
   :target: https://buildstream.gitlab.io/bst-plugins-container

.. image:: https://img.shields.io/badge/Source-teal.svg?logo=gitlab&labelColor=grey
   :target: https://gitlab.com/BuildStream/bst-plugins-container

A collection of plugins for `BuildStream <https://BuildStream.build>`_ that are
related to containers.

Usage
=====

There are two ways to use external BuildStream plugins, either as a submodule,
or as a Python package. See BuildStream's
`External plugin documentation <https://docs.buildstream.build/master/format_project.html#loading-plugins>`_
for more details.

Using the plugins as a Python package
-------------------------------------
To use the container plugins as a Python package within a BuildStream project,
you will first need to install bst-plugins-container via pip::

   pip install bst-plugins-container

The plugins must be declared in *project.conf*. To do this, please refer
to BuildStream's
`Local plugins documentation <https://docs.buildstream.build/master/format_project.html#local-plugins>`_.

Using the plugins locally within a project
------------------------------------------
To use the container plugins locally within a
BuildStream project, you will first need to clone the repo to a location
**within your project**::

    git clone https://gitlab.com/BuildStream/bst-plugins-container.git

The plugins must be declared in *project.conf*. To do this, please refer
to BuildStream's
`Pip plugins documentation <https://docs.buildstream.build/master/format_project.html#local-plugins>`_.
