system_helpers.apt.install
==========================

.. py:module:: system_helpers.apt.install


Classes
-------

.. autoapisummary::

   system_helpers.apt.install.Cleaner


Functions
---------

.. autoapisummary::

   system_helpers.apt.install.get_list_of_packages_from_requirements_file
   system_helpers.apt.install.install_command
   system_helpers.apt.install.install_packages


Module Contents
---------------

.. py:function:: get_list_of_packages_from_requirements_file(*, file: pathlib.Path) -> List[str]

   Get list of packages from a requirements file.

   Note that this function only supports skipping empty lines and comment lines, *i.e.*,
   not all features from https://pip.pypa.io/en/stable/reference/requirements-file-format/
   are supported.


.. py:function:: install_command(*, yes: bool = True, no_install_recommends: bool = True) -> List[str]

   Get the `apt` command to install packages.


.. py:class:: Cleaner

   .. py:method:: run() -> None
      :staticmethod:



.. py:function:: install_packages(*, packages: Optional[List[str]] = None, requirements: Optional[List[pathlib.Path]] = None, update: bool = False, upgrade: bool = False, clean: bool = False, args: Optional[List[str]] = None) -> None

   Install list of packages by using `apt`.

   Optionally:
       * update
       * upgrade
       * clean