python-xbox 0.1.0rc2__tar.gz → 0.1.0rc3__tar.gz

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-xbox
-Version: 0.1.0rc2
+Version: 0.1.0rc3
 Summary: A library to authenticate with Xbox Network and use their API
 Project-URL: Homepage, https://github.com/tr4nt0r/python-xbox
 Author: OpenXbox
@@ -17,11 +17,12 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.11
-Requires-Dist: appdirs
 Requires-Dist: ecdsa
 Requires-Dist: httpx
 Requires-Dist: ms-cv
 Requires-Dist: pydantic==2.*
+Provides-Extra: cli
+Requires-Dist: platformdirs>=4.5.0; extra == 'cli'
 Description-Content-Type: text/markdown
 
 # Xbox-WebAPI

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/pyproject.toml

@@ -5,7 +5,6 @@ authors = [
     {name = "OpenXbox"},
 ]
 dependencies = [
-    "appdirs",
     "ecdsa",
     "httpx",
     "ms_cv",
@@ -31,6 +30,11 @@ dynamic = ["version"]
 [project.urls]
 Homepage = "https://github.com/tr4nt0r/python-xbox"
 
+[project.optional-dependencies]
+cli = [
+    "platformdirs>=4.5.0"
+]
+
 [project.scripts]
 xbox-authenticate = "pythonxbox.scripts.authenticate:main"
 xbox-change-gt = "pythonxbox.scripts.change_gamertag:main"
@@ -40,15 +44,21 @@ xbox-xal = "pythonxbox.scripts.xal:main"
 
 [tool.ruff]
 line-length = 88
-target-version = "py38"
+target-version = "py311"
 
 [tool.ruff.lint]
-select = ["E4", "E7", "E9", "F"]
+select = ["E4", "E7", "E9", "F", "UP", "S"]
 ignore = []
 
+
+[tool.ruff.lint.per-file-ignores]
+"**/scripts/*" = ["UP", "S104"]
+"tests/*" = ["S101"]
+"src/pythonxbox/authentication/xal.py" = ["S101"]
+
 [tool.ruff.lint.isort]
 force-sort-within-sections = true
-known-first-party = ["aiontfy"]
+known-first-party = ["pythonxbox"]
 combine-as-imports = true
 split-on-trailing-comma = false
 
@@ -56,25 +66,6 @@ split-on-trailing-comma = false
 quote-style = "double"
 indent-style = "space"
 
-
-[tool.bandit]
-exclude_dirs = ["tests"]
-tests = [
-  "B108",
-  "B306",
-  "B307",
-  "B313",
-  "B314",
-  "B315",
-  "B316",
-  "B317",
-  "B318",
-  "B319",
-  "B320",
-  "B602",
-  "B604"
-]
-
 [tool.hatch.version]
 source = "regex_commit"
 commit_extra_args = ["-e"]
@@ -90,7 +81,7 @@ packages = ["src/pythonxbox"]
 [tool.hatch.envs.default]
 python = "3.13"
 dependencies = [
-    "appdirs==1.4.4",
+    "platformdirs==4.5.0",
     "ecdsa==0.19.1",
     "httpx==0.28.1",
     "ms_cv==0.1.1",

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/src/pythonxbox/__init__.py

@@ -1,4 +1,4 @@
 """Top-level package for xbox-webapi-python."""
 
 __author__ = """OpenXbox"""
-__version__ = "0.1.0rc2"
+__version__ = "0.1.0rc3"

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/src/pythonxbox/api/provider/achievements/models.py

@@ -1,5 +1,5 @@
 from datetime import datetime, time
-from typing import Any, List, Optional
+from typing import Any
 
 from pydantic import BaseModel
 
@@ -7,7 +7,7 @@ from pythonxbox.common.models import CamelCaseModel
 
 
 class PagingInfo(CamelCaseModel):
-    continuation_token: Optional[str] = None
+    continuation_token: str | None = None
     total_records: int
 
 
@@ -37,20 +37,20 @@ class Title360(CamelCaseModel):
     sequence: int
     title_id: int
     title_type: int
-    platforms: List[int]
+    platforms: list[int]
     name: str
     total_achievements: int
     total_gamerscore: int
 
 
 class Achievement360Response(CamelCaseModel):
-    achievements: List[Achievement360]
+    achievements: list[Achievement360]
     paging_info: PagingInfo
     version: datetime
 
 
 class Achievement360ProgressResponse(CamelCaseModel):
-    titles: List[Title360]
+    titles: list[Title360]
     paging_info: PagingInfo
     version: datetime
 
@@ -62,7 +62,7 @@ class TitleAssociation(BaseModel):
 
 class Requirement(CamelCaseModel):
     id: str
-    current: Optional[str] = None
+    current: str | None = None
     target: str
     operation_type: str
     value_type: str
@@ -70,7 +70,7 @@ class Requirement(CamelCaseModel):
 
 
 class Progression(CamelCaseModel):
-    requirements: List[Requirement]
+    requirements: list[Requirement]
     time_unlocked: datetime
 
 
@@ -93,11 +93,11 @@ class Achievement(CamelCaseModel):
     id: str
     service_config_id: str
     name: str
-    title_associations: List[TitleAssociation]
+    title_associations: list[TitleAssociation]
     progress_state: str
     progression: Progression
-    media_assets: List[MediaAsset]
-    platforms: List[str]
+    media_assets: list[MediaAsset]
+    platforms: list[str]
     is_secret: bool
     description: str
     locked_description: str
@@ -105,14 +105,14 @@ class Achievement(CamelCaseModel):
     achievement_type: str
     participation_type: str
     time_window: Any = None
-    rewards: List[Reward]
+    rewards: list[Reward]
     estimated_time: time
     deeplink: Any = None
     is_revoked: bool
 
 
 class AchievementResponse(CamelCaseModel):
-    achievements: List[Achievement]
+    achievements: list[Achievement]
     paging_info: PagingInfo
 
 
@@ -129,5 +129,5 @@ class Title(CamelCaseModel):
 
 
 class RecentProgressResponse(CamelCaseModel):
-    titles: List[Title]
+    titles: list[Title]
     paging_info: PagingInfo

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/src/pythonxbox/api/provider/catalog/__init__.py

@@ -2,8 +2,6 @@
 Store Catalog - Lookup Product Information
 """
 
-from typing import List
-
 from pythonxbox.api.provider.baseprovider import BaseProvider
 from pythonxbox.api.provider.catalog.models import (
     AlternateIdType,
@@ -20,7 +18,7 @@ class CatalogProvider(BaseProvider):
 
     async def get_products(
         self,
-        big_ids: List[str],
+        big_ids: list[str],
         fields: FieldsTemplate = FieldsTemplate.DETAILS,
         **kwargs,
     ) -> CatalogResponse:

python_xbox-0.1.0rc3/src/pythonxbox/api/provider/catalog/models.py

@@ -0,0 +1,428 @@
+from datetime import datetime
+from enum import Enum
+from typing import Any
+
+from pydantic import Field, field_validator
+
+from pythonxbox.common.models import PascalCaseModel
+
+
+class AlternateIdType(str, Enum):
+    LEGACY_XBOX_PRODUCT_ID = "LegacyXboxProductId"
+    XBOX_TITLE_ID = "XboxTitleId"
+    PACKAGE_FAMILY_NAME = "PackageFamilyName"
+
+
+class FieldsTemplate(str, Enum):
+    BROWSE = "browse"
+    DETAILS = "details"
+
+
+class PlatformType(str, Enum):
+    XBOX = "windows.xbox"
+    DESKTOP = "windows.desktop"
+
+
+class Image(PascalCaseModel):
+    file_id: str | None = None
+    eis_listing_identifier: Any = Field(None, alias="EISListingIdentifier")
+    background_color: str | None = None
+    caption: str | None = None
+    file_size_in_bytes: int
+    foreground_color: str | None = None
+    height: int
+    image_position_info: str | None = None
+    image_purpose: str
+    unscaled_image_sha256_hash: str | None = Field(
+        None, alias="UnscaledImageSHA256Hash"
+    )
+    uri: str
+    width: int
+
+
+class Video(PascalCaseModel):
+    uri: str
+    video_purpose: str
+    height: int
+    width: int
+    audio_encoding: str
+    video_encoding: str
+    video_position_info: str
+    caption: str
+    file_size_in_bytes: int
+    preview_image: Image
+    sort_order: int
+
+
+class SearchTitle(PascalCaseModel):
+    search_title_string: str
+    search_title_type: str
+
+
+class ContentRating(PascalCaseModel):
+    rating_system: str
+    rating_id: str
+    rating_descriptors: list[str]
+    rating_disclaimers: list
+    interactive_elements: list | None = None
+
+
+class UsageData(PascalCaseModel):
+    aggregate_time_span: str
+    average_rating: float
+    play_count: int | None = None
+    rating_count: int
+    rental_count: str | None = None
+    trial_count: str | None = None
+    purchase_count: str | None = None
+
+
+class ProductProperties(PascalCaseModel):
+    attributes: list | None = None
+    can_install_to_sd_card: bool | None = Field(None, alias="CanInstallToSDCard")
+    category: str | None = None
+    sub_category: str | None = None
+    categories: list[str] | None = None
+    extensions: Any = None
+    is_accessible: bool | None = None
+    is_line_of_business_app: bool | None = None
+    is_published_to_legacy_windows_phone_store: bool | None = None
+    is_published_to_legacy_windows_store: bool | None = None
+    is_settings_app: bool | None = None
+    package_family_name: str | None = None
+    package_identity_name: str | None = None
+    publisher_certificate_name: str | None = None
+    publisher_id: str
+    xbox_live_tier: Any = None
+    xbox_xpa: Any = Field(None, alias="XboxXPA")
+    xbox_cross_gen_set_id: Any = None
+    xbox_console_gen_optimized: Any = None
+    xbox_console_gen_compatible: Any = None
+    xbox_live_gold_required: bool | None = None
+    ownership_type: Any = None
+    pdp_background_color: str | None = None
+    has_add_ons: bool | None = None
+    revision_id: str
+    product_group_id: str | None = None
+    product_group_name: str | None = None
+
+
+class AlternateId(PascalCaseModel):
+    id_type: str
+    value: str
+
+
+class ValidationData(PascalCaseModel):
+    passed_validation: bool
+    revision_id: str
+    validation_result_uri: str | None = None
+
+
+class FulfillmentData(PascalCaseModel):
+    product_id: str
+    wu_bundle_id: str | None = None
+    wu_category_id: str
+    package_family_name: str
+    sku_id: str
+    content: Any = None
+    package_features: Any = None
+
+
+class HardwareProperties(PascalCaseModel):
+    minimum_hardware: list
+    recommended_hardware: list
+    minimum_processor: Any = None
+    recommended_processor: Any = None
+    minimum_graphics: Any = None
+    recommended_graphics: Any = None
+
+
+class Application(PascalCaseModel):
+    application_id: str
+    declaration_order: int
+    extensions: list[str]
+
+
+class FrameworkDependency(PascalCaseModel):
+    max_tested: int
+    min_version: int
+    package_identity: str
+
+
+class PlatformDependency(PascalCaseModel):
+    max_tested: int | None = None
+    min_version: int | None = None
+    platform_name: str
+
+
+class Package(PascalCaseModel):
+    applications: list[Application] | None = None
+    architectures: list[str]
+    capabilities: list[str] | None = None
+    device_capabilities: list[str] | None = None
+    experience_ids: list | None = None
+    framework_dependencies: list[FrameworkDependency] | None = None
+    hardware_dependencies: list | None = None
+    hardware_requirements: list | None = None
+    hash: str | None = None
+    hash_algorithm: str | None = None
+    is_streaming_app: bool | None = None
+    languages: list[str] | None = None
+    max_download_size_in_bytes: int
+    max_install_size_in_bytes: int | None = None
+    package_format: str
+    package_family_name: str | None = None
+    main_package_family_name_for_dlc: Any = None
+    package_full_name: str | None = None
+    package_id: str
+    content_id: str
+    key_id: str | None = None
+    package_rank: int | None = None
+    package_uri: str | None = None
+    platform_dependencies: list[PlatformDependency] | None = None
+    platform_dependency_xml_blob: str | None = None
+    resource_id: str | None = None
+    version: str | None = None
+    package_download_uris: Any = None
+    driver_dependencies: list | None = None
+    fulfillment_data: FulfillmentData | None = None
+
+
+class LegalText(PascalCaseModel):
+    additional_license_terms: str
+    copyright: str
+    copyright_uri: str
+    privacy_policy: str
+    privacy_policy_uri: str
+    tou: str
+    tou_uri: str
+
+
+class SkuLocalizedProperty(PascalCaseModel):
+    contributors: list | None = None
+    features: list | None = None
+    minimum_notes: str | None = None
+    recommended_notes: str | None = None
+    release_notes: str | None = None
+    display_platform_properties: Any = None
+    sku_description: str
+    sku_title: str
+    sku_button_title: str | None = None
+    delivery_date_overlay: Any = None
+    sku_display_rank: list | None = None
+    text_resources: Any = None
+    images: list | None = None
+    legal_text: LegalText | None = None
+    language: str
+    markets: list[str]
+
+
+class SkuMarketProperty(PascalCaseModel):
+    first_available_date: datetime | str | None = None
+    supported_languages: list[str] | None = None
+    package_ids: Any = None
+    pi_filter: Any = Field(None, alias="PIFilter")
+    markets: list[str]
+
+
+class SkuProperties(PascalCaseModel):
+    early_adopter_enrollment_url: Any = None
+    fulfillment_data: FulfillmentData | None = None
+    fulfillment_type: str | None = None
+    fulfillment_plugin_id: Any = None
+    has_third_party_iaps: bool | None = Field(None, alias="HasThirdPartyIAPs")
+    last_update_date: datetime | None = None
+    hardware_properties: HardwareProperties | None = None
+    hardware_requirements: list | None = None
+    hardware_warning_list: list | None = None
+    installation_terms: str
+    packages: list[Package] | None = None
+    version_string: str | None = None
+    visible_to_b2b_service_ids: list = Field(alias="VisibleToB2BServiceIds")
+    xbox_xpa: bool | None = Field(None, alias="XboxXPA")
+    bundled_skus: list | None = None
+    is_repurchasable: bool
+    sku_display_rank: int
+    display_physical_store_inventory: Any = None
+    additional_identifiers: list
+    is_trial: bool
+    is_pre_order: bool
+    is_bundle: bool
+
+    @field_validator("last_update_date", mode="before", check_fields=True)
+    def validator(x):
+        return x or None
+
+
+class Sku(PascalCaseModel):
+    last_modified_date: datetime
+    localized_properties: list[SkuLocalizedProperty]
+    market_properties: list[SkuMarketProperty]
+    product_id: str
+    properties: SkuProperties
+    sku_a_schema: str
+    sku_b_schema: str
+    sku_id: str
+    sku_type: str
+    recurrence_policy: Any = None
+    subscription_policy_id: Any = None
+
+
+class AllowedPlatform(PascalCaseModel):
+    max_version: int | None = None
+    min_version: int | None = None
+    platform_name: str
+
+
+class ClientConditions(PascalCaseModel):
+    allowed_platforms: list[AllowedPlatform]
+
+
+class Conditions(PascalCaseModel):
+    client_conditions: ClientConditions
+    end_date: datetime
+    resource_set_ids: list[str]
+    start_date: datetime
+
+
+class PIFilter(PascalCaseModel):
+    exclusion_properties: list
+    inclusion_properties: list
+
+
+class Price(PascalCaseModel):
+    currency_code: str
+    is_pi_required: bool = Field(alias="IsPIRequired")
+    list_price: float
+    msrp: float = Field(alias="MSRP")
+    tax_type: str
+    wholesale_currency_code: str
+
+
+class OrderManagementData(PascalCaseModel):
+    granted_entitlement_keys: list | None = None
+    pi_filter: PIFilter | None = Field(None, alias="PIFilter")
+    price: Price
+
+
+class AvailabilityProperties(PascalCaseModel):
+    original_release_date: datetime | None = None
+
+
+class SatisfyingEntitlementKey(PascalCaseModel):
+    entitlement_keys: list[str]
+    licensing_key_ids: list[str]
+
+
+class LicensingData(PascalCaseModel):
+    satisfying_entitlement_keys: list[SatisfyingEntitlementKey]
+
+
+class Availability(PascalCaseModel):
+    actions: list[str]
+    availability_a_schema: str | None = None
+    availability_b_schema: str | None = None
+    availability_id: str | None = None
+    conditions: Conditions | None = None
+    last_modified_date: datetime | None = None
+    markets: list[str] | None = None
+    order_management_data: OrderManagementData | None = None
+    properties: AvailabilityProperties | None = None
+    sku_id: str | None = None
+    display_rank: int | None = None
+    remediation_required: bool | None = None
+    licensing_data: LicensingData | None = None
+
+
+class DisplaySkuAvailability(PascalCaseModel):
+    sku: Sku | None = None
+    availabilities: list[Availability]
+
+
+class LocalizedProperty(PascalCaseModel):
+    developer_name: str | None = None
+    display_platform_properties: Any | None = None
+    publisher_name: str | None = None
+    publisher_website_uri: str | None = None
+    support_uri: str | None = None
+    eligibility_properties: Any | None = None
+    franchises: list | None = None
+    images: list[Image]
+    videos: list[Video] | None = None
+    product_description: str | None = None
+    product_title: str
+    short_title: str | None = None
+    sort_title: str | None = None
+    friendly_title: str | None = None
+    short_description: str | None = None
+    search_titles: list[SearchTitle] | None = None
+    voice_title: str | None = None
+    render_group_details: Any | None = None
+    product_display_ranks: list | None = None
+    interactive_model_config: Any | None = None
+    interactive_3d_enabled: bool | None = Field(None, alias="Interactive3DEnabled")
+    language: str | None = None
+    markets: list[str] | None = None
+
+
+class MarketProperty(PascalCaseModel):
+    original_release_date: datetime | None = None
+    original_release_friendly_name: str | None = None
+    minimum_user_age: int | None = None
+    content_ratings: list[ContentRating] | None = None
+    related_products: list | None = None
+    usage_data: list[UsageData]
+    bundle_config: Any | None = None
+    markets: list[str] | None = None
+
+
+class Product(PascalCaseModel):
+    last_modified_date: datetime | None = None
+    localized_properties: list[LocalizedProperty]
+    market_properties: list[MarketProperty]
+    product_a_schema: str | None = None
+    product_b_schema: str | None = None
+    product_id: str
+    properties: ProductProperties | None = None
+    alternate_ids: list[AlternateId] | None = None
+    domain_data_version: Any | None = None
+    ingestion_source: str | None = None
+    is_microsoft_product: bool | None = None
+    preferred_sku_id: str | None = None
+    product_type: str | None = None
+    validation_data: ValidationData | None = None
+    merchandizing_tags: list | None = None
+    part_d: str | None = None
+    product_family: str
+    schema_version: str | None = None
+    product_kind: str
+    display_sku_availabilities: list[DisplaySkuAvailability]
+
+
+class CatalogResponse(PascalCaseModel):
+    big_ids: list[str] | None = None
+    has_more_pages: bool | None = None
+    products: list[Product]
+    total_result_count: int | None = None
+
+
+class SearchProduct(PascalCaseModel):
+    background_color: str | None = None
+    height: int | None = None
+    image_type: str | None = None
+    width: int | None = None
+    platform_properties: list
+    icon: str | None = None
+    product_id: str
+    type: str
+    title: str
+
+
+class CatalogSearchResult(PascalCaseModel):
+    product_family_name: str
+    products: list[SearchProduct]
+
+
+class CatalogSearchResponse(PascalCaseModel):
+    results: list[CatalogSearchResult]
+    total_result_count: int

{python_xbox-0.1.0rc2 → python_xbox-0.1.0rc3}/src/pythonxbox/api/provider/cqs/models.py

@@ -1,4 +1,4 @@
-from typing import Any, Dict, List, Optional
+from typing import Any
 
 from pythonxbox.common.models import PascalCaseModel
 
@@ -16,12 +16,12 @@ class ListChannel(PascalCaseModel):
     channel_number: str
     start_date: str
     end_date: str
-    images: List[Image]
-    is_HD: Optional[bool] = None
+    images: list[Image]
+    is_HD: bool | None = None
 
 
 class CqsChannelListResponse(PascalCaseModel):
-    channels: List[ListChannel]
+    channels: list[ListChannel]
 
 
 class Genre(PascalCaseModel):
@@ -40,20 +40,20 @@ class Program(PascalCaseModel):
     end_date: str
     name: str
     is_repeat: bool
-    parental_control: Optional[Dict[str, Any]] = None
-    genres: List[Genre]
+    parental_control: dict[str, Any] | None = None
+    genres: list[Genre]
     category_id: int
-    description: Optional[str] = None
-    parent_series: Optional[ParentSeries] = None
-    images: Optional[List[Image]] = None
+    description: str | None = None
+    parent_series: ParentSeries | None = None
+    images: list[Image] | None = None
 
 
 class ScheduleChannel(PascalCaseModel):
     id: str
     name: str
-    images: List[Image]
-    programs: List[Program]
+    images: list[Image]
+    programs: list[Program]
 
 
 class CqsScheduleResponse(PascalCaseModel):
-    channels: List[ScheduleChannel]
+    channels: list[ScheduleChannel]