nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-07-22 11:59:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

components: Add docstrings & tutorial for Packages

Browse Source 
Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net>
[sunil: Include the new component reference in the components index]
[sunil: Minor changes to component doc string]
Signed-off-by: Sunil Mohan Adapa <sunil@medhas.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
This commit is contained in:
Joseph Nuthalapati 2021-11-05 16:05:11 +05:30 committed by Sunil Mohan Adapa
parent 6e68614e21
commit 53fbaf27f2
No known key found for this signature in database
GPG Key ID: 43EA1CFF0AA7C5F2
4 changed files with 54 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/dev/reference/components/index.rst
View File

@ -8,6 +8,7 @@ Components
info
menu
packages
daemon
firewall
webserver

7
doc/dev/reference/components/packages.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0
Packages
^^^^^^^^
.. autoclass:: plinth.package.Packages
:members:

30
doc/dev/tutorial/components.rst
View File

@ -112,6 +112,36 @@ the daemon. The final argument is the list of ports that this daemon listens on.
This information is used to check if the daemon is listening on the expected
ports when the user requests diagnostic tests on the app.
Package management
^^^^^^^^^^^^^^^^^^
Transmission server is installed through a set of packages fetched from Debian
package repositories. The packages required for this are passed on to a
:class:`~plinth.package.Packages` component which takes care of installing,
upgrading and uninstalling the Debian packages. An app might require one or more
Debian packages to be installed.
.. code-block:: python3
:caption: ``__init__.py``
from plinth.package import Packages
managed_packages = ['transmission-daemon']
class TransmissionApp(app_module.App):
...
def __init__(self):
...
packages = Packages('packages-transmission', managed_packages)
self.add(packages)
The first argument uniquely identifies this instance of the `Packages`
component. Choose an appropriate unique identifier if your app has multiple
`Packages` components. The second argument is a list of Debian packages that
this component is responsible for.
Managing web server configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

20
plinth/package.py
View File

@ -21,16 +21,28 @@ logger = logging.getLogger(__name__)
class Packages(app.FollowerComponent):
"""Component to manage the packages of an app."""
"""Component to manage the packages of an app.
def __init__(self, component_id, packages):
super(Packages, self).__init__(component_id)
This component is responsible for installation, upgrades and uninstallation
of packages required by an app.
"""
def __init__(self, component_id: str, packages: list[str]):
"""Initialize a new packages component.
'component_id' should be a unique ID across all components of an app
and across all components.
'packages' is the list of Debian packages managed by this component.
"""
super().__init__(component_id)
self.component_id = component_id
self._packages = packages
@property
def packages(self):
def packages(self) -> list[str]:
"""Return the list of packages managed by this component."""
return self._packages