craft-application 2.6.2__tar.gz → 2.7.0__tar.gz

{craft_application-2.6.2 → craft_application-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.6.2
+Version: 2.7.0
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -47,17 +47,12 @@ Requires-Dist: codespell[toml]==2.2.6; extra == "lint"
 Requires-Dist: yamllint==1.35.1; extra == "lint"
 Provides-Extra: types
 Requires-Dist: mypy[reports]==1.9.0; extra == "types"
-Requires-Dist: pyright==1.1.358; extra == "types"
+Requires-Dist: pyright==1.1.359; extra == "types"
 Requires-Dist: types-requests; extra == "types"
 Requires-Dist: types-urllib3; extra == "types"
 Provides-Extra: docs
-Requires-Dist: furo==2024.1.29; extra == "docs"
-Requires-Dist: sphinx<7.3,>=7.2.6; extra == "docs"
+Requires-Dist: canonical-sphinx~=0.1; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
-Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
-Requires-Dist: sphinx-design==0.5.0; extra == "docs"
-Requires-Dist: sphinx-pydantic==0.1.1; extra == "docs"
-Requires-Dist: sphinx-toolbox==3.5.0; extra == "docs"
 Requires-Dist: sphinx-lint==0.9.1; extra == "docs"
 Provides-Extra: apt
 Requires-Dist: python-apt>=2.4.0; sys_platform == "linux" and extra == "apt"

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.6.2'
-__version_tuple__ = version_tuple = (2, 6, 2)
+__version__ = version = '2.7.0'
+__version_tuple__ = version_tuple = (2, 7, 0)

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/application.py

@@ -280,11 +280,18 @@ class Application:
             self._full_build_plan, platform, build_for, host_arch
         )
 
-        if platform and not build_for:
-            all_platforms = {b.platform: b for b in self._full_build_plan}
-            if platform not in all_platforms:
-                raise errors.InvalidPlatformError(platform, list(all_platforms.keys()))
-            build_for = all_platforms[platform].build_for
+        if not build_for:
+            # get the build-for arch from the platform
+            if platform:
+                all_platforms = {b.platform: b for b in self._full_build_plan}
+                if platform not in all_platforms:
+                    raise errors.InvalidPlatformError(
+                        platform, list(all_platforms.keys())
+                    )
+                build_for = all_platforms[platform].build_for
+            # otherwise get the build-for arch from the build plan
+            elif self._build_plan:
+                build_for = self._build_plan[0].build_for
 
         # validate project grammar
         GrammarAwareProject.validate_grammar(yaml_data)
@@ -497,7 +504,7 @@ class Application:
             self._pre_run(dispatcher)
 
             managed_mode = command.run_managed(dispatcher.parsed_args())
-            if managed_mode or command.always_load_project:
+            if managed_mode or command.needs_project(dispatcher.parsed_args()):
                 self.services.project = self.get_project(
                     platform=platform, build_for=build_for
                 )
@@ -576,34 +583,29 @@ class Application:
         Performs task such as environment expansion. Note that this transforms
         ``yaml_data`` in-place.
         """
+        # apply application-specific transformations first because an application may
+        # add advanced grammar, project variables, or secrets to the yaml
+        yaml_data = self._extra_yaml_transform(
+            yaml_data, build_on=build_on, build_for=build_for
+        )
+
+        # At the moment there is no perfect solution for what do to do
+        # expand project variables or to resolve the grammar if there's
+        # no explicitly-provided target arch. However, we must resolve
+        # it with *something* otherwise we might have an invalid parts
+        # definition full of grammar declarations and incorrect build_for
+        # architectures.
+        build_for = build_for or build_on
+
         # Perform variable expansion.
-        self._expand_environment(yaml_data)
+        self._expand_environment(yaml_data=yaml_data, build_for=build_for)
 
         # Handle build secrets.
         if self.app.features.build_secrets:
             self._render_secrets(yaml_data)
 
-        # apply application-specific transformations before expanding grammar
-        # because an application may add advanced grammar to the yaml
-        yaml_data = self._extra_yaml_transform(
-            yaml_data, build_on=build_on, build_for=build_for
-        )
-
         # Expand grammar.
         if "parts" in yaml_data:
-            if not build_for:
-                # At the moment there is no perfect solution for what do to do
-                # resolve the grammar if there's no explicitly-provided target
-                # arch. However, we must resolve it with *something* otherwise
-                # we might have an invalid parts definition full of grammar
-                # declarations.
-                if self._build_plan:
-                    # If we have a build plan use one of its items, because
-                    # it's likely contemplated on the grammar.
-                    build_for = self._build_plan[0].build_for
-                else:
-                    # As a last resort, default to the same arch as the host.
-                    build_for = build_on
             craft_cli.emit.debug(f"Processing grammar (on {build_on} for {build_for})")
             yaml_data["parts"] = grammar.process_parts(
                 parts_yaml_data=yaml_data["parts"],
@@ -613,8 +615,12 @@ class Application:
 
         return yaml_data
 
-    def _expand_environment(self, yaml_data: dict[str, Any]) -> None:
-        """Perform expansion of project environment variables."""
+    def _expand_environment(self, yaml_data: dict[str, Any], build_for: str) -> None:
+        """Perform expansion of project environment variables.
+
+        :param yaml_data: The project's yaml data.
+        :param build_for: The architecture to build for.
+        """
         environment_vars = self._get_project_vars(yaml_data)
         project_dirs = craft_parts.ProjectDirs(
             work_dir=self._work_dir, partitions=self._partitions
@@ -623,6 +629,7 @@ class Application:
         info = craft_parts.ProjectInfo(
             application_name=self.app.name,  # not used in environment expansion
             cache_dir=pathlib.Path(),  # not used in environment expansion
+            arch=util.convert_architecture_deb_to_platform(build_for),
             project_name=yaml_data.get("name", ""),
             project_dirs=project_dirs,
             project_vars=environment_vars,

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/commands/__init__.py

@@ -17,13 +17,17 @@
 
 from craft_application.commands.base import AppCommand, ExtensibleCommand
 from craft_application.commands import lifecycle
-from craft_application.commands.lifecycle import get_lifecycle_command_group
+from craft_application.commands.lifecycle import (
+    get_lifecycle_command_group,
+    LifecycleCommand,
+)
 from craft_application.commands.other import get_other_command_group
 
 __all__ = [
     "AppCommand",
     "ExtensibleCommand",
     "lifecycle",
+    "LifecycleCommand",
     "get_lifecycle_command_group",
     "get_other_command_group",
 ]

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/commands/base.py

@@ -65,6 +65,20 @@ class AppCommand(BaseCommand):
         self._app: application.AppMetadata = config["app"]
         self._services: service_factory.ServiceFactory = config["services"]
 
+    def needs_project(
+        self,
+        parsed_args: argparse.Namespace,  # noqa: ARG002 (unused argument is for subclasses)
+    ) -> bool:
+        """Property to determine if the command needs a project loaded.
+
+        Defaults to `self.always_load_project`. Subclasses can override this property
+
+        :param parsed_args: Parsed arguments for the command.
+
+        :returns: True if the command needs a project loaded, False otherwise.
+        """
+        return self.always_load_project
+
     def run_managed(
         self,
         parsed_args: argparse.Namespace,  # noqa: ARG002 (the unused argument is for subclasses)

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/commands/lifecycle.py

@@ -32,7 +32,7 @@ if TYPE_CHECKING:  # pragma: no cover
 
 def get_lifecycle_command_group() -> CommandGroup:
     """Return the lifecycle related command group."""
-    commands: list[type[_LifecycleCommand]] = [
+    commands: list[type[_BaseLifecycleCommand]] = [
         CleanCommand,
         PullCommand,
         OverlayCommand,
@@ -50,30 +50,21 @@ def get_lifecycle_command_group() -> CommandGroup:
     )
 
 
-class _LifecycleCommand(base.ExtensibleCommand):
-    """Lifecycle-related commands."""
+class _BaseLifecycleCommand(base.ExtensibleCommand):
+    """Base class for lifecycle-related commands.
+
+    All lifecycle commands must know where to execute (locally or in a build
+    environment) but do not have to provide shell access into the environment.
+    """
 
     @override
     def _run(self, parsed_args: argparse.Namespace, **kwargs: Any) -> None:
         emit.trace(f"lifecycle command: {self.name!r}, arguments: {parsed_args!r}")
 
-
-class LifecyclePartsCommand(_LifecycleCommand):
-    """A lifecycle command that uses parts."""
-
-    # All lifecycle-related commands need a project to work
-    always_load_project = True
-
     @override
     def _fill_parser(self, parser: argparse.ArgumentParser) -> None:
         super()._fill_parser(parser)  # type: ignore[arg-type]
-        parser.add_argument(
-            "parts",
-            metavar="part-name",
-            type=str,
-            nargs="*",
-            help="Optional list of parts to process",
-        )
+
         group = parser.add_mutually_exclusive_group()
         group.add_argument(
             "--destructive-mode",
@@ -121,8 +112,12 @@ class LifecyclePartsCommand(_LifecycleCommand):
         return True
 
 
-class LifecycleStepCommand(LifecyclePartsCommand):
-    """An actual lifecycle step."""
+class LifecycleCommand(_BaseLifecycleCommand):
+    """A command that will run the lifecycle and can shell into the environment.
+
+    LifecycleCommands do not require a part. For example 'pack' will run
+    the lifecycle but cannot be run on a specific part.
+    """
 
     @override
     def _fill_parser(self, parser: argparse.ArgumentParser) -> None:
@@ -202,10 +197,7 @@ class LifecycleStepCommand(LifecyclePartsCommand):
             shell_after = True
 
         try:
-            self._services.lifecycle.run(
-                step_name=step_name,
-                part_names=parsed_args.parts,
-            )
+            self._run_lifecycle(parsed_args, step_name)
         except Exception as err:
             if debug:
                 emit.progress(str(err), permanent=True)
@@ -215,12 +207,48 @@ class LifecycleStepCommand(LifecyclePartsCommand):
         if shell_after:
             _launch_shell()
 
+    def _run_lifecycle(
+        self,
+        parsed_args: argparse.Namespace,  # noqa: ARG002 (unused argument is for subclasses)
+        step_name: str | None = None,
+    ) -> None:
+        """Run the lifecycle."""
+        self._services.lifecycle.run(step_name=step_name)
+
     @staticmethod
     def _should_add_shell_args() -> bool:
         return True
 
 
-class PullCommand(LifecycleStepCommand):
+class LifecyclePartsCommand(LifecycleCommand):
+    """A command that can run the lifecycle for a particular part."""
+
+    # All lifecycle-related commands need a project to work
+    always_load_project = True
+
+    @override
+    def _fill_parser(self, parser: argparse.ArgumentParser) -> None:
+        super()._fill_parser(parser)  # type: ignore[arg-type]
+        parser.add_argument(
+            "parts",
+            metavar="part-name",
+            type=str,
+            nargs="*",
+            help="Optional list of parts to process",
+        )
+
+    @override
+    def _run_lifecycle(
+        self, parsed_args: argparse.Namespace, step_name: str | None = None
+    ) -> None:
+        """Run the lifecycle, optionally for a part or list of parts."""
+        self._services.lifecycle.run(
+            step_name=step_name,
+            part_names=parsed_args.parts,
+        )
+
+
+class PullCommand(LifecyclePartsCommand):
     """Command to pull parts."""
 
     name = "pull"
@@ -234,7 +262,7 @@ class PullCommand(LifecycleStepCommand):
     )
 
 
-class OverlayCommand(LifecycleStepCommand):
+class OverlayCommand(LifecyclePartsCommand):
     """Command to overlay parts."""
 
     name = "overlay"
@@ -247,7 +275,7 @@ class OverlayCommand(LifecycleStepCommand):
     )
 
 
-class BuildCommand(LifecycleStepCommand):
+class BuildCommand(LifecyclePartsCommand):
     """Command to build parts."""
 
     name = "build"
@@ -260,7 +288,7 @@ class BuildCommand(LifecycleStepCommand):
     )
 
 
-class StageCommand(LifecycleStepCommand):
+class StageCommand(LifecyclePartsCommand):
     """Command to stage parts."""
 
     name = "stage"
@@ -274,7 +302,7 @@ class StageCommand(LifecycleStepCommand):
     )
 
 
-class PrimeCommand(LifecycleStepCommand):
+class PrimeCommand(LifecyclePartsCommand):
     """Command to prime parts."""
 
     name = "prime"
@@ -355,9 +383,10 @@ class PackCommand(PrimeCommand):
         return False
 
 
-class CleanCommand(LifecyclePartsCommand):
+class CleanCommand(_BaseLifecycleCommand):
     """Command to remove part assets."""
 
+    always_load_project = True
     name = "clean"
     help_msg = "Remove a part's assets"
     overview = textwrap.dedent(
@@ -368,7 +397,22 @@ class CleanCommand(LifecyclePartsCommand):
     )
 
     @override
-    def _run(self, parsed_args: argparse.Namespace, **kwargs: Any) -> None:
+    def _fill_parser(self, parser: argparse.ArgumentParser) -> None:
+        super()._fill_parser(parser)  # type: ignore[arg-type]
+        parser.add_argument(
+            "parts",
+            metavar="part-name",
+            type=str,
+            nargs="*",
+            help="Optional list of parts to process",
+        )
+
+    @override
+    def _run(
+        self,
+        parsed_args: argparse.Namespace,
+        **kwargs: Any,
+    ) -> None:
         """Run the clean command.
 
         The project's work directory will be cleaned if:

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/errors.py

@@ -136,7 +136,7 @@ class MultipleBuildsError(CraftError):
 
     def __init__(self) -> None:
         message = "Multiple builds match the current platform."
-        resolution = 'Check the "--platform" and "--bulld-for" parameters.'
+        resolution = 'Check the "--platform" and "--build-for" parameters.'
 
         super().__init__(message=message, resolution=resolution)
 

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/models/__init__.py

@@ -1,6 +1,6 @@
 # This file is part of craft_application.
 #
-# Copyright 2023 Canonical Ltd.
+# Copyright 2023-2024 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU Lesser General Public License version 3, as
@@ -28,12 +28,20 @@ from craft_application.models.grammar import (
     get_grammar_aware_part_keywords,
 )
 from craft_application.models.metadata import BaseMetadata
-from craft_application.models.project import BuildInfo, BuildPlanner, Project
+from craft_application.models.project import (
+    DEVEL_BASE_INFOS,
+    DEVEL_BASE_WARNING,
+    BuildInfo,
+    BuildPlanner,
+    Project,
+)
 
 
 __all__ = [
     "BaseMetadata",
     "BuildInfo",
+    "DEVEL_BASE_INFOS",
+    "DEVEL_BASE_WARNING",
     "CraftBaseConfig",
     "CraftBaseModel",
     "get_grammar_aware_part_keywords",

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/models/project.py

@@ -24,9 +24,12 @@ from typing import Any
 import craft_parts
 import craft_providers.bases
 import pydantic
+from craft_cli import emit
+from craft_providers.errors import BaseConfigurationError
 from pydantic import AnyUrl
 from typing_extensions import override
 
+from craft_application import errors
 from craft_application.models.base import CraftBaseConfig, CraftBaseModel
 from craft_application.models.constraints import (
     MESSAGE_INVALID_NAME,
@@ -39,6 +42,33 @@ from craft_application.models.constraints import (
 )
 
 
+@dataclasses.dataclass
+class DevelBaseInfo:
+    """Devel base information for an OS."""
+
+    current_devel_base: craft_providers.bases.BaseAlias
+    """The base that the 'devel' alias currently points to."""
+
+    devel_base: craft_providers.bases.BaseAlias
+    """The devel base."""
+
+
+# A list of DevelBaseInfo objects that define an OS's current devel base and devel base.
+DEVEL_BASE_INFOS = [
+    DevelBaseInfo(
+        # TODO: current_devel_base should point to 24.10, which is not available yet
+        current_devel_base=craft_providers.bases.ubuntu.BuilddBaseAlias.DEVEL,
+        devel_base=craft_providers.bases.ubuntu.BuilddBaseAlias.DEVEL,
+    ),
+]
+
+DEVEL_BASE_WARNING = (
+    "The development build-base should only be used for testing purposes, "
+    "as its contents are bound to change with the opening of new Ubuntu releases, "
+    "suddenly and without warning."
+)
+
+
 @dataclasses.dataclass
 class BuildInfo:
     """Platform build information."""
@@ -115,6 +145,58 @@ class Project(CraftBaseModel):
             return self.base
         raise RuntimeError("Could not determine effective base")
 
+    @classmethod
+    def _providers_base(cls, base: str) -> craft_providers.bases.BaseAlias | None:
+        """Get a BaseAlias from the Project base.
+
+        The default naming convention for a base is 'name@channel'. This method
+        should be overridden for applications with a different naming convention.
+
+        :param base: The base name.
+
+        :returns: The BaseAlias for the base or None if the base does not map to
+          a BaseAlias.
+
+        :raises CraftValidationError: If the project's base cannot be determined.
+        """
+        try:
+            name, channel = base.split("@")
+            return craft_providers.bases.get_base_alias((name, channel))
+        except (ValueError, BaseConfigurationError) as err:
+            raise errors.CraftValidationError(f"Unknown base {base!r}") from err
+
+    @pydantic.root_validator(  # pyright: ignore[reportUnknownMemberType,reportUntypedFunctionDecorator]
+        pre=False
+    )
+    def _validate_devel(cls, values: dict[str, Any]) -> dict[str, Any]:
+        """Validate the build-base is 'devel' for the current devel base."""
+        base = values.get("base")
+        # if there is no base, do not validate the build-base
+        if not base:
+            return values
+
+        base_alias = cls._providers_base(base)
+
+        # if the base does not map to a base alias, do not validate the build-base
+        if not base_alias:
+            return values
+
+        build_base = values.get("build_base") or base
+        build_base_alias = cls._providers_base(build_base)
+
+        # warn if a devel build-base is being used, error if a devel build-base is not
+        # used for a devel base
+        for devel_base_info in DEVEL_BASE_INFOS:
+            if base_alias == devel_base_info.current_devel_base:
+                if build_base_alias == devel_base_info.devel_base:
+                    emit.message(DEVEL_BASE_WARNING)
+                else:
+                    raise errors.CraftValidationError(
+                        f"A development build-base must be used when base is {base!r}"
+                    )
+
+        return values
+
     @override
     @classmethod
     def transform_pydantic_error(cls, error: pydantic.ValidationError) -> None:

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/remote/utils.py

@@ -85,7 +85,7 @@ def _compute_hash(directory: Path) -> str:
             "a directory."
         )
 
-    files = sorted([file for file in Path().glob("**/*") if file.is_file()])
+    files = sorted(file for file in directory.glob("**/*") if file.is_file())
     hashes: list[str] = []
 
     for file_path in files:

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/services/lifecycle.py

@@ -263,7 +263,7 @@ class LifecycleService(base.ProjectService):
             raise RuntimeError(f"Parts processing internal error: {err}") from err
         except OSError as err:
             raise errors.PartsLifecycleError.from_os_error(err) from err
-        except Exception as err:  # noqa: BLE001 - Converting general error.
+        except Exception as err:
             raise errors.PartsLifecycleError(f"Unknown error: {str(err)}") from err
 
     def post_prime(self, step_info: StepInfo) -> bool:

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application/services/provider.py

@@ -105,7 +105,7 @@ class ProviderService(base.ProjectService):
     ) -> Generator[craft_providers.Executor, None, None]:
         """Context manager for getting a provider instance.
 
-        :param base_name: A craft_providers capable base name (tuple of name, version)
+        :param build_info: Build information for the instance.
         :param work_dir: Local path to mount inside the provider instance.
         :param allow_unstable: Whether to allow the use of unstable images.
         :returns: a context manager of the provider instance.

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: craft-application
-Version: 2.6.2
+Version: 2.7.0
 Summary: A framework for *craft applications.
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
@@ -47,17 +47,12 @@ Requires-Dist: codespell[toml]==2.2.6; extra == "lint"
 Requires-Dist: yamllint==1.35.1; extra == "lint"
 Provides-Extra: types
 Requires-Dist: mypy[reports]==1.9.0; extra == "types"
-Requires-Dist: pyright==1.1.358; extra == "types"
+Requires-Dist: pyright==1.1.359; extra == "types"
 Requires-Dist: types-requests; extra == "types"
 Requires-Dist: types-urllib3; extra == "types"
 Provides-Extra: docs
-Requires-Dist: furo==2024.1.29; extra == "docs"
-Requires-Dist: sphinx<7.3,>=7.2.6; extra == "docs"
+Requires-Dist: canonical-sphinx~=0.1; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.2.4; extra == "docs"
-Requires-Dist: sphinx-copybutton==0.5.2; extra == "docs"
-Requires-Dist: sphinx-design==0.5.0; extra == "docs"
-Requires-Dist: sphinx-pydantic==0.1.1; extra == "docs"
-Requires-Dist: sphinx-toolbox==3.5.0; extra == "docs"
 Requires-Dist: sphinx-lint==0.9.1; extra == "docs"
 Provides-Extra: apt
 Requires-Dist: python-apt>=2.4.0; sys_platform == "linux" and extra == "apt"

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application.egg-info/SOURCES.txt

@@ -79,7 +79,6 @@ craft_application/util/string.py
 craft_application/util/yaml.py
 docs/conf.py
 docs/index.rst
-docs/_static/css/custom.css
 docs/explanation/index.rst
 docs/howto/index.rst
 docs/reference/index.rst

{craft_application-2.6.2 → craft_application-2.7.0}/craft_application.egg-info/requires.txt

@@ -30,13 +30,8 @@ responses~=0.25.0
 craft-application[remote]
 
 [docs]
-furo==2024.1.29
-sphinx<7.3,>=7.2.6
+canonical-sphinx~=0.1
 sphinx-autobuild==2024.2.4
-sphinx-copybutton==0.5.2
-sphinx-design==0.5.0
-sphinx-pydantic==0.1.1
-sphinx-toolbox==3.5.0
 sphinx-lint==0.9.1
 
 [lint]
@@ -49,6 +44,6 @@ launchpadlib>=1.10.16
 
 [types]
 mypy[reports]==1.9.0
-pyright==1.1.358
+pyright==1.1.359
 types-requests
 types-urllib3

craft_application-2.7.0/docs/conf.py

@@ -0,0 +1,42 @@
+# Copyright 2023-2024 Canonical Ltd.
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License version 3 as published by the Free Software Foundation.
+#
+# 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
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser 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.
+#
+
+import datetime
+
+project = "Craft Application"
+author = "Canonical Group Ltd"
+
+copyright = "2023-%s, %s" % (datetime.date.today().year, author)
+
+# region Configuration for canonical-sphinx
+ogp_site_url = "https://canonical-craft-application.readthedocs-hosted.com/"
+ogp_site_name = project
+
+html_context = {
+    "product_page": "github.com/canonical/craft-application",
+    "github_url": "https://github.com/canonical/craft-application",
+}
+
+extensions = [
+    "canonical_sphinx",
+]
+# endregion
+
+# region Options for extensions
+# Github config
+github_username = "canonical"
+github_repository = "craft-application"
+# endregion