snap-python 0.0.3__tar.gz → 0.0.5__tar.gz

{snap_python-0.0.3 → snap_python-0.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snap-python
-Version: 0.0.3
+Version: 0.0.5
 Summary: An api to interact with snapd and snap stores
 Home-page: https://github.com/alexlukens/snap-python
 License: MIT
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: httpx (>=0.27.2,<0.28.0)
 Requires-Dist: pydantic (>=2.9.2,<3.0.0)
 Requires-Dist: retry (>=0.9.2,<0.10.0)
@@ -38,6 +39,15 @@ Here is a simple example of how to use snap_python:
 # TODO
 ```
 
+## Create a Release
+
+```bash
+git tag -a v0.x.x -m "Release v0.x.x"
+gh release create v0.x.x --title "Release v0.x.x"
+```
+
+The automation will build a wheel and push it to pypi
+
 ## License
 
 This project is licensed under the MIT License. See the LICENSE file for more details.

{snap_python-0.0.3 → snap_python-0.0.5}/README.md

@@ -18,6 +18,15 @@ Here is a simple example of how to use snap_python:
 # TODO
 ```
 
+## Create a Release
+
+```bash
+git tag -a v0.x.x -m "Release v0.x.x"
+gh release create v0.x.x --title "Release v0.x.x"
+```
+
+The automation will build a wheel and push it to pypi
+
 ## License
 
 This project is licensed under the MIT License. See the LICENSE file for more details.

{snap_python-0.0.3 → snap_python-0.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snap-python"
-version = "0.0.3"
+version = "0.0.5"
 description = "An api to interact with snapd and snap stores"
 authors = ["Alexander Lukens <alexdlukens@gmail.com>"]
 license = "MIT"

{snap_python-0.0.3 → snap_python-0.0.5}/src/snap_python/client.py

@@ -27,6 +27,7 @@ class SnapClient(AbstractSnapsClient):
         tcp_location: str = None,
         store_base_url: str = "https://api.snapcraft.io",
         store_headers: dict[str, str] = None,
+        prompt_for_authentication: bool = False,
     ):
         if tcp_location and snapd_socket_location:
             raise ValueError(
@@ -40,14 +41,19 @@ class SnapClient(AbstractSnapsClient):
             self._transport = httpx.AsyncHTTPTransport(
                 uds=snapd_socket_location or SNAPD_SOCKET
             )
-
         if store_headers is None:
             store_headers = {"Snap-Device-Series": "16", "X-Ubuntu-Series": "16"}
 
+        snapd_headers = {}
+        if prompt_for_authentication:
+            snapd_headers = {"X-Allow-Interaction": "true"}
+
         self.version = version
         self.store_base_url = store_base_url
         self.store_headers = store_headers
-        self.snapd_client = httpx.AsyncClient(transport=self._transport)
+        self.snapd_client = httpx.AsyncClient(
+            transport=self._transport, headers=snapd_headers
+        )
         self.snaps = SnapsEndpoints(self)
         self.store = StoreEndpoints(
             base_url=self.store_base_url,

{snap_python-0.0.3 → snap_python-0.0.5}/src/snap_python/components/snaps.py

@@ -6,7 +6,10 @@ import httpx
 
 from snap_python.schemas.changes import ChangesResponse
 from snap_python.schemas.common import AsyncResponse
-from snap_python.schemas.snaps import SingleSnapResponse, SnapListResponse
+from snap_python.schemas.snaps import (
+    InstalledSnapListResponse,
+    SingleInstalledSnapResponse,
+)
 from snap_python.utils import AbstractSnapsClient, going_to_reload_daemon
 
 logger = logging.getLogger("snap_python.components.snaps")
@@ -17,12 +20,12 @@ class SnapsEndpoints:
         self._client = client
         self.common_endpoint = "snaps"
 
-    async def list_installed_snaps(self) -> SnapListResponse:
+    async def list_installed_snaps(self) -> InstalledSnapListResponse:
         response: httpx.Response = await self._client.request(
             "GET", self.common_endpoint
         )
 
-        response = SnapListResponse.model_validate_json(response.content)
+        response = InstalledSnapListResponse.model_validate_json(response.content)
         if response.status_code > 299:
             raise httpx.HTTPStatusError(
                 request=response.request,
@@ -31,7 +34,7 @@ class SnapsEndpoints:
             )
         return response
 
-    async def get_snap_info(self, snap: str) -> SingleSnapResponse:
+    async def get_snap_info(self, snap: str) -> SingleInstalledSnapResponse:
         try:
             response: httpx.Response = await self._client.request(
                 "GET", f"{self.common_endpoint}/{snap}"
@@ -44,7 +47,7 @@ class SnapsEndpoints:
             )
             response = e.response
 
-        return SingleSnapResponse.model_validate_json(response.content)
+        return SingleInstalledSnapResponse.model_validate_json(response.content)
 
     async def is_snap_installed(self, snap: str) -> bool:
         snap_info = await self.get_snap_info(snap)
@@ -57,6 +60,7 @@ class SnapsEndpoints:
         snap: str,
         channel: str = "stable",
         classic: bool = False,
+        dangerous: bool = False,
         devmode: bool = False,
         ignore_validation: bool = False,
         jailmode: bool = False,
@@ -73,6 +77,7 @@ class SnapsEndpoints:
             snap (str): name of the snap to install
             channel (str, optional): Channel to install. Defaults to "stable".
             classic (bool, optional): Install with classic confinement. Defaults to False.
+            dangerous (bool, optional): install the given snap files even if there are no pre-acknowledged signatures for them, meaning they are not verified and could be dangerous if true (optional, implied by devmode). Defaults to False.
             devmode (bool, optional): Install with devmode. Defaults to False.
             ignore_validation (bool, optional): _description_. Defaults to False.
             jailmode (bool, optional): Install snap with jailmode. Defaults to False.
@@ -90,6 +95,7 @@ class SnapsEndpoints:
             "action": "install",
             "channel": channel,
             "classic": classic,
+            "dangerous": dangerous,
             "devmode": devmode,
             "ignore_validation": ignore_validation,
             "jailmode": jailmode,
@@ -100,7 +106,10 @@ class SnapsEndpoints:
             # sideload
             if not Path(filename).exists():
                 raise FileNotFoundError(f"File {filename} does not exist")
-            request_data["dangerous"] = True
+            if request_data.get("dangerous") is not True:
+                raise ValueError(
+                    "Cannot sideload snap without dangerous flag set to True"
+                )
             raw_response: httpx.Response = await self._client.request(
                 "POST",
                 f"{self.common_endpoint}",

{snap_python-0.0.3 → snap_python-0.0.5}/src/snap_python/schemas/common.py

@@ -62,3 +62,39 @@ class Media(BaseModel):
 
 class AsyncResponse(BaseResponse):
     change: str
+
+
+class Download(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    size: float
+
+
+class Revision(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    base: Optional[SnapBaseVersion] = None
+    channel: Optional[str] = None
+    common_ids: Optional[list[str]] = Field(
+        None, validation_alias=AliasChoices("common-ids", "common_ids")
+    )
+    confinement: Optional[SnapConfinement] = None
+    download: Optional[Download] = None
+    revision: Optional[int | str] = None
+    type: Optional[str] = None
+    version: Optional[str] = None
+
+
+class Publisher(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    display_name: str = Field(
+        ...,
+        validation_alias=AliasChoices("display-name", "display_name"),
+        description="Display name corresponding to the publisher.",
+    )
+    id: str = Field(..., description="The publisher id.")
+    username: str = Field(..., description="Username belonging to the publisher.")
+    validation: Optional[str] = Field(
+        None, description="Indicates if the account has been validated."
+    )

snap_python-0.0.5/src/snap_python/schemas/snaps.py

@@ -0,0 +1,100 @@
+from typing import Optional
+
+from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
+
+from snap_python.schemas.common import (
+    BaseErrorResult,
+    BaseResponse,
+    Media,
+    Publisher,
+    Revision,
+    SnapApp,
+)
+from snap_python.schemas.store.categories import Category
+
+
+class SnapHealth(BaseModel):
+    status: str
+    revision: str
+    timestamp: AwareDatetime
+
+
+class InstalledSnapFields(Revision):
+    apps: list[SnapApp] = Field(default_factory=list)
+    developer: Optional[str] = None
+    devmode: Optional[bool] = None
+    health: Optional[SnapHealth] = None
+    icon: Optional[str] = None
+    id: Optional[str] = Field(
+        None, validation_alias=AliasChoices("id", "snap-id"), serialization_alias="id"
+    )
+    ignore_validation: bool = Field(
+        validation_alias=AliasChoices("ignore-validation", "ignore_validation"),
+        serialization_alias="ignore-validation",
+    )
+    install_date: AwareDatetime = Field(
+        validation_alias=AliasChoices("install-date", "install_date"),
+        serialization_alias="install-date",
+    )
+    installed_size: int = Field(
+        validation_alias=AliasChoices("installed-size", "installed_size"),
+        serialization_alias="installed-size",
+    )
+    jailmode: bool
+    mounted_from: str = Field(
+        validation_alias=AliasChoices("mounted-from", "mounted_from"),
+        serialization_alias="mounted-from",
+    )
+    status: str
+    tracking_channel: Optional[str] = Field(
+        validation_alias=AliasChoices("tracking-channel", "tracking_channel"),
+        serialization_alias="tracking-channel",
+        default=None,
+    )
+
+
+class StoreSnapFields(BaseModel):
+    gated_snap_ids: Optional[list[str]] = Field(
+        None, alias=AliasChoices("gated-snap-ids", "gated_snap_ids")
+    )
+    categories: Optional[list[Category]] = None
+    prices: Optional[dict[str, str]] = None
+    snap_id: Optional[str] = Field(None, alias=AliasChoices("snap-id", "snap_id"))
+    store_url: Optional[str] = Field(None, alias=AliasChoices("store-url", "store_url"))
+    trending: Optional[bool] = None
+
+
+class Snap(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    contact: Optional[str] = None
+    description: Optional[str] = None
+    license: str = "unset"
+    links: Optional[dict[str, list[str]]] = None
+    media: Optional[list[Media]] = None
+    name: Optional[str] = None
+    private: Optional[bool] = None
+    publisher: Optional[Publisher] = Field(None, description="The publisher.")
+    summary: Optional[str] = None
+    title: Optional[str] = None
+    unlisted: Optional[bool] = None
+    website: Optional[str] = None
+
+
+class StoreSnap(Snap, StoreSnapFields):
+    pass
+
+
+class InstalledSnap(Snap, InstalledSnapFields):
+    pass
+
+
+class SingleInstalledSnapResponse(BaseResponse):
+    result: InstalledSnap | BaseErrorResult
+
+
+class InstalledSnapListResponse(BaseResponse):
+    result: list[InstalledSnap]
+
+    def __len__(self):
+        return len(self.result)

{snap_python-0.0.3 → snap_python-0.0.5}/src/snap_python/schemas/store/info.py

@@ -6,7 +6,7 @@ from typing import List, Optional
 
 from pydantic import AwareDatetime, BaseModel, ConfigDict, Field
 
-from snap_python.schemas.store.search import Snap
+from snap_python.schemas.snaps import StoreSnap
 
 VALID_SNAP_INFO_FIELDS = [
     "architectures",
@@ -130,5 +130,5 @@ class InfoResponse(BaseModel):
     default_track: Optional[str] = Field(None, alias="default-track")
     error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
     name: str
-    snap: Snap
+    snap: StoreSnap
     snap_id: str = Field(..., alias="snap-id")

snap_python-0.0.5/src/snap_python/schemas/store/search.py

@@ -0,0 +1,122 @@
+from typing import Any, Dict, List, Optional
+
+from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
+
+from snap_python.schemas.common import Revision
+from snap_python.schemas.snaps import InstalledSnap, Snap, StoreSnap, StoreSnapFields
+
+VALID_SEARCH_CATEGORY_FIELDS = [
+    "base",
+    "categories",
+    "channel",
+    "common-ids",
+    "confinement",
+    "contact",
+    "description",
+    "download",
+    "license",
+    "media",
+    "prices",
+    "private",
+    "publisher",
+    "revision",
+    "store-url",
+    "summary",
+    "title",
+    "type",
+    "version",
+    "website",
+]
+
+
+class ErrorListItem(BaseModel):
+    model_config = ConfigDict(extra="forbid", exclude_unset=True)
+
+    code: str
+    message: str
+
+
+class SnapDetails(BaseModel):
+    aliases: Optional[List[Dict]] = None
+    anon_download_url: str
+    apps: Optional[List[str]] = None
+    architecture: List[str]
+    base: Optional[str] = None
+    binary_filesize: int
+    channel: str
+    common_ids: List[str]
+    confinement: str
+    contact: Optional[str] = None
+    content: Optional[str] = None
+    date_published: AwareDatetime
+    deltas: Optional[List[str]] = None
+    description: str
+    developer_id: str
+    developer_name: str
+    developer_validation: str
+    download_sha3_384: Optional[str] = None
+    download_sha512: Optional[str] = None
+    download_url: str
+    epoch: str
+    gated_snap_ids: Optional[List[str]] = None
+    icon_url: str
+    last_updated: AwareDatetime
+    license: str
+    links: Dict[str, Any]
+    name: str
+    origin: str
+    package_name: str
+    prices: Dict[str, Any]
+    private: bool
+    publisher: str
+    raitings_average: float = 0.0
+    release: List[str]
+    revision: int
+    screenshot_urls: List[str]
+    snap_id: Optional[str] = None
+    summary: Optional[str] = None
+    support_url: Optional[str] = None
+    title: Optional[str] = None
+    version: Optional[str] = None
+    website: Optional[str] = None
+
+
+class SearchResult(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    name: str
+    revision: Optional[Revision] = None
+    snap: StoreSnap
+    snap_id: str = Field(alias=AliasChoices("snap-id", "snap_id"))
+
+    @classmethod
+    def from_installed_snap(cls, installed_snap: InstalledSnap):
+        snap_info: dict = installed_snap.model_dump(mode="json")
+        revision_snap_fields = Revision.model_fields.keys()
+        revision_info = {}
+        for field in revision_snap_fields:
+            if field in snap_info:
+                revision_info[field] = snap_info.pop(field)
+
+        snap_id = snap_info.pop("id")
+        snap_name = snap_info.get("name")
+
+        # get set of acceptable fields for StoreSnap
+        store_snap_fields = set(StoreSnapFields.model_fields.keys()).union(
+            Snap.model_fields.keys()
+        )
+        store_snap_info = {
+            key: value for key, value in snap_info.items() if key in store_snap_fields
+        }
+
+        snap_info = {"snap": store_snap_info, "snap-id": snap_id, "name": snap_name}
+        snap_info["revision"] = revision_info
+
+        return cls.model_validate(snap_info)
+
+
+class SearchResponse(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+    error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
+    results: List[SearchResult]

snap_python-0.0.3/src/snap_python/schemas/snaps.py

@@ -1,70 +0,0 @@
-from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
-
-from snap_python.schemas.common import (
-    BaseErrorResult,
-    BaseResponse,
-    Media,
-    SnapApp,
-    SnapBaseVersion,
-    SnapConfinement,
-)
-
-
-class Snap(BaseModel):
-    model_config = ConfigDict(extra="allow")
-    apps: list[SnapApp] = Field(default_factory=list)
-    base: SnapBaseVersion | None = None
-    channel: str
-    confinement: SnapConfinement
-    contact: str
-    description: str
-    developer: str
-    devmode: bool
-    icon: str | None = None
-    id: str
-    ignore_validation: bool = Field(
-        validation_alias=AliasChoices("ignore-validation", "ignore_validation"),
-        serialization_alias="ignore-validation",
-    )
-    install_date: AwareDatetime = Field(
-        validation_alias=AliasChoices("install-date", "install_date"),
-        serialization_alias="install-date",
-    )
-    installed_size: int = Field(
-        validation_alias=AliasChoices("installed-size", "installed_size"),
-        serialization_alias="installed-size",
-    )
-    jailmode: bool
-    license: str = "unset"
-    links: dict[str, list[str]] | None = None
-    media: list[Media] = Field(default_factory=list)
-    mounted_from: str = Field(
-        validation_alias=AliasChoices("mounted-from", "mounted_from"),
-        serialization_alias="mounted-from",
-    )
-    name: str
-    private: bool
-    publisher: dict[str, str] | None = None
-    revision: str
-    status: str
-    summary: str
-    title: str | None = None
-    tracking_channel: str | None = Field(
-        validation_alias=AliasChoices("tracking-channel", "tracking_channel"),
-        serialization_alias="tracking-channel",
-        default=None,
-    )
-    type: str
-    version: str
-    website: str | None = None
-
-
-class SingleSnapResponse(BaseResponse):
-    result: Snap | BaseErrorResult
-
-
-class SnapListResponse(BaseResponse):
-    result: list[Snap]
-
-    def __len__(self):
-        return len(self.result)

snap_python-0.0.3/src/snap_python/schemas/store/search.py

@@ -1,160 +0,0 @@
-# generated by datamodel-codegen:
-#   filename:  snaps_find_schema.json
-#   timestamp: 2024-09-17T01:18:24+00:00
-
-
-from typing import Any, Dict, List, Optional
-
-from pydantic import AliasChoices, AwareDatetime, BaseModel, ConfigDict, Field
-
-from snap_python.schemas.store.categories import Category, Media
-
-VALID_SEARCH_CATEGORY_FIELDS = [
-    "base",
-    "categories",
-    "channel",
-    "common-ids",
-    "confinement",
-    "contact",
-    "description",
-    "download",
-    "license",
-    "media",
-    "prices",
-    "private",
-    "publisher",
-    "revision",
-    "store-url",
-    "summary",
-    "title",
-    "type",
-    "version",
-    "website",
-]
-
-
-class ErrorListItem(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    code: str
-    message: str
-
-
-class Download(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    size: float
-
-
-class Revision(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    base: Optional[str] = None
-    channel: Optional[str] = None
-    common_ids: Optional[List[str]] = Field(None, alias="common-ids")
-    confinement: Optional[str] = None
-    download: Optional[Download] = None
-    revision: Optional[float] = None
-    type: Optional[str] = None
-    version: Optional[str] = None
-
-
-class Publisher(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    display_name: str = Field(
-        ...,
-        alias="display-name",
-        description="Display name corresponding to the publisher.",
-    )
-    id: str = Field(..., description="The publisher id.")
-    username: str = Field(..., description="Username belonging to the publisher.")
-    validation: Optional[str] = Field(
-        None, description="Indicates if the account has been validated."
-    )
-
-
-class Snap(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True)
-
-    categories: Optional[List[Category]] = None
-    contact: Optional[str] = None
-    description: Optional[str] = ""
-    gated_snap_ids: Optional[List[str]] = Field(
-        None, alias=AliasChoices("gated-snap-ids", "gated_snap_ids")
-    )
-    license: Optional[str] = None
-    links: Optional[Dict[str, Any]] = None
-    media: Optional[List[Media]] = None
-    name: Optional[str] = None
-    prices: Optional[Dict[str, Any]] = None
-    private: Optional[bool] = None
-    publisher: Optional[Publisher] = Field(None, description="The publisher.")
-    snap_id: Optional[str] = Field(None, alias=AliasChoices("snap-id", "snap_id"))
-    store_url: Optional[str] = Field(None, alias=AliasChoices("store-url", "store_url"))
-    summary: Optional[str] = None
-    title: Optional[str] = None
-    trending: Optional[bool] = None
-    unlisted: Optional[bool] = None
-    website: Optional[str] = None
-
-
-class SnapDetails(BaseModel):
-    aliases: Optional[List[Dict]] = None
-    anon_download_url: str
-    apps: Optional[List[str]] = None
-    architecture: List[str]
-    base: Optional[str] = None
-    binary_filesize: int
-    channel: str
-    common_ids: List[str]
-    confinement: str
-    contact: Optional[str] = None
-    content: Optional[str] = None
-    date_published: AwareDatetime
-    deltas: Optional[List[str]] = None
-    description: str
-    developer_id: str
-    developer_name: str
-    developer_validation: str
-    download_sha3_384: Optional[str] = None
-    download_sha512: Optional[str] = None
-    download_url: str
-    epoch: str
-    gated_snap_ids: Optional[List[str]] = None
-    icon_url: str
-    last_updated: AwareDatetime
-    license: str
-    links: Dict[str, Any]
-    name: str
-    origin: str
-    package_name: str
-    prices: Dict[str, Any]
-    private: bool
-    publisher: str
-    raitings_average: float = 0.0
-    release: List[str]
-    revision: int
-    screenshot_urls: List[str]
-    snap_id: Optional[str] = None
-    summary: Optional[str] = None
-    support_url: Optional[str] = None
-    title: Optional[str] = None
-    version: Optional[str] = None
-    website: Optional[str] = None
-
-
-class SearchResult(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True, exclude_none=True)
-
-    name: str
-    revision: Optional[Revision] = None
-    snap: Snap
-    snap_id: str = Field(alias=AliasChoices("snap-id", "snap_id"))
-
-
-class SearchResponse(BaseModel):
-    model_config = ConfigDict(extra="forbid", exclude_unset=True, exclude_none=True)
-
-    error_list: Optional[List[ErrorListItem]] = Field(None, alias="error-list")
-    results: List[SearchResult]