karrio-generic 2025.5rc1__py3-none-any.whl

karrio/mappers/generic/__init__.py

@@ -0,0 +1,3 @@
+from karrio.mappers.generic.mapper import Mapper
+from karrio.mappers.generic.proxy import Proxy
+from karrio.mappers.generic.settings import Settings

karrio/mappers/generic/mapper.py

@@ -0,0 +1,38 @@
+from typing import List, Tuple
+from karrio.core.utils.serializable import Serializable, Deserializable
+from karrio.api.mapper import Mapper as BaseMapper
+from karrio.core.models import (
+    RateDetails,
+    RateRequest,
+    Message,
+    ShipmentDetails,
+)
+from karrio.universal.providers.shipping import (
+    parse_shipment_response,
+    shipment_request,
+)
+from karrio.universal.providers.rating import (
+    parse_rate_response,
+    rate_request,
+)
+from karrio.mappers.generic.settings import Settings
+
+
+class Mapper(BaseMapper):
+    settings: Settings
+
+    def create_rate_request(self, payload: RateRequest) -> Serializable:
+        return rate_request(payload, self.settings)
+
+    def create_shipment_request(self, payload: Serializable) -> Serializable:
+        return shipment_request(payload, self.settings)
+
+    def parse_rate_response(
+        self, response: Deserializable
+    ) -> Tuple[List[RateDetails], List[Message]]:
+        return parse_rate_response(response, self.settings)
+
+    def parse_shipment_response(
+        self, response: Deserializable
+    ) -> Tuple[ShipmentDetails, List[Message]]:
+        return parse_shipment_response(response, self.settings)

karrio/mappers/generic/proxy.py

@@ -0,0 +1,15 @@
+from karrio.api.proxy import Proxy as BaseProxy
+from karrio.universal.mappers.rating_proxy import RatingMixinProxy
+from karrio.universal.mappers.shipping_proxy import ShippingMixinProxy
+from karrio.mappers.generic.settings import Settings
+
+
+Proxy = type(
+    "Proxy",
+    (BaseProxy,),
+    dict(
+        settings=Settings,
+        get_rates=RatingMixinProxy.get_rates,
+        create_shipment=ShippingMixinProxy.create_shipment,
+    ),
+)

karrio/mappers/generic/settings.py

@@ -0,0 +1,29 @@
+"""Karrio Generic client settings."""
+
+from typing import List
+import attr
+from jstruct.types import JList, JStruct
+from karrio.core.models import ServiceLevel, LabelTemplate
+from karrio.universal.mappers.rating_proxy import RatingMixinSettings
+from karrio.universal.mappers.shipping_proxy import ShippingMixinSettings
+from karrio.providers.generic.units import DEFAULT_SERVICES
+from karrio.providers.generic.utils import Settings as BaseSettings
+
+
+@attr.s(auto_attribs=True)
+class Settings(BaseSettings, RatingMixinSettings, ShippingMixinSettings):
+    """Generic connection settings."""
+
+    display_name: str
+    custom_carrier_name: str
+
+    test_mode: bool = False
+    carrier_id: str = "custom-carrier"
+    account_country_code: str = None
+    account_number: str = None
+    metadata: dict = {}
+    config: dict = {}
+    id: str = None
+
+    label_template: LabelTemplate = JStruct[LabelTemplate]
+    services: List[ServiceLevel] = JList[ServiceLevel, False, dict(default=DEFAULT_SERVICES)]  # type: ignore

karrio/plugins/generic/__init__.py

@@ -0,0 +1,19 @@
+import karrio.core.metadata as metadata
+import karrio.mappers.generic as mappers
+import karrio.providers.generic.units as units
+
+METADATA = metadata.PluginMetadata(
+    status="production-ready",
+    id="generic",
+    label="Custom Carrier",
+    # Integrations
+    Mapper=mappers.Mapper,
+    Proxy=mappers.Proxy,
+    Settings=mappers.Settings,
+    # Data Units
+    services=units.Service,
+    options=units.Option,
+    service_levels=units.DEFAULT_SERVICES,
+    connection_configs=units.ConnectionConfig,
+    has_intl_accounts=True,
+)

karrio/providers/generic/units.py

@@ -0,0 +1,81 @@
+import karrio.lib as lib
+import karrio.core.models as models
+
+
+class ConnectionConfig(lib.Enum):
+    text_color = lib.OptionEnum("text_color")
+    brand_color = lib.OptionEnum("brand_color")
+
+
+class Service(lib.Enum):
+    standard_service = "standard"
+
+
+class Option(lib.Enum):
+    tracking_number_reference = lib.OptionEnum("tracking_number")
+
+
+DEFAULT_SERVICES = [
+    models.ServiceLevel(
+        service_name="Standard Service",
+        service_code="standard_service",
+        currency="USD",
+        transit_days=1,
+        zones=[models.ServiceZone(label="Zone 1", rate=0.0)],
+    ),
+]
+
+SAMPLE_SHIPMENT_REQUEST = {
+    "service": "carrier_premium",
+    "label_type": "ZPL",
+    "shipper": {
+        "company_name": "CGI",
+        "address_line1": "502 MAIN ST N",
+        "city": "MONTREAL",
+        "postal_code": "H2B1A0",
+        "country_code": "CA",
+        "person_name": "Bob",
+        "phone_number": "1 (450) 823-8432",
+        "state_code": "QC",
+    },
+    "recipient": {
+        "company_name": "CGI",
+        "address_line1": "23 jardin private",
+        "city": "Ottawa",
+        "postal_code": "K1K4T3",
+        "country_code": "CA",
+        "person_name": "Jain",
+        "state_code": "ON",
+    },
+    "parcels": [
+        {
+            "height": 3.0,
+            "length": 5.0,
+            "width": 3.0,
+            "weight": 4.0,
+            "dimension_unit": "IN",
+            "weight_unit": "LB",
+            "reference_number": "2975565",
+            "items": [
+                {
+                    "weight": 1.0,
+                    "weight_unit": "LB",
+                    "quantity": 1,
+                    "title": "Item 1",
+                    "sku": "SKU-1",
+                    "metadata": {
+                        "RFF_CN": "037-2332855",
+                        "BGM": "040000000000016256",
+                        "RFF_ON": "5424560",
+                        "DEPT": "DBR128",
+                        "CTL": "11253678",
+                        "XXNC": "138039C01",
+                        "NAD_UD": "570162",
+                        "RFF_AJY": "907",
+                        "RFF_AEM": "3901L",
+                    },
+                },
+            ],
+        }
+    ],
+}

karrio/providers/generic/utils.py

@@ -0,0 +1,21 @@
+"""Karrio Generic client settings."""
+
+import karrio.lib as lib
+from karrio.core.settings import Settings as BaseSettings
+
+
+class Settings(BaseSettings):
+    """Generic connection settings."""
+
+    @property
+    def carrier_name(self):
+        return "generic"
+
+    @property
+    def connection_config(self) -> lib.units.Options:
+        from karrio.providers.generic.units import ConnectionConfig
+
+        return lib.to_connection_config(
+            self.config or {},
+            option_type=ConnectionConfig,
+        )

karrio_generic-2025.5rc1.dist-info/METADATA

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: karrio_generic
+Version: 2025.5rc1
+Summary: Karrio - Custom carrier Shipping extension
+Author-email: karrio <hello@karrio.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/karrioapi/karrio
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: karrio
+
+# karrio.generic
+
+This package is a Generic extension of the [karrio](https://pypi.org/project/karrio) multi carrier shipping SDK.
+
+## Requirements
+
+`Python 3.11+`
+
+## Installation
+
+```bash
+pip install karrio.generic
+```
+
+## Usage
+
+```python
+import karrio.sdk as karrio
+from karrio.mappers.generic.settings import Settings
+
+
+# Initialize a carrier gateway
+canadapost = karrio.gateway["generic"].create(
+    Settings(
+        ...
+    )
+)
+```
+
+Check the [Karrio Mutli-carrier SDK docs](https://docs.karrio.io) for Shipping API requests

karrio_generic-2025.5rc1.dist-info/RECORD

@@ -0,0 +1,13 @@
+karrio/mappers/generic/__init__.py,sha256=eizJesNxYg-FdtvbWso16wcpdnuClROT4Q-Df3d3eec,149
+karrio/mappers/generic/mapper.py,sha256=vzWGp4DzadAmrUqzBZbVtDdy0-g55iPKCXeSTWuXiCk,1182
+karrio/mappers/generic/proxy.py,sha256=nQxbLSwouoP_Vm0sjiutsELSEQEfz96ZYEqR7I3QAgM,438
+karrio/mappers/generic/settings.py,sha256=qxjExbUEje19cf4VVDFaxQIKddAAzWuBR8BiQzM2LtE,1012
+karrio/plugins/generic/__init__.py,sha256=2jRHdsHUevSCaW1WbQXNIucu3iplmPDp2ajJHlASHvw,535
+karrio/providers/generic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+karrio/providers/generic/units.py,sha256=-nN2LvdEDVVbciU3iGyKn8zjm0L3TAfzju0PBzaawsY,2212
+karrio/providers/generic/utils.py,sha256=dBlGrhkD4g2ZmkYnxKUF3H8hQgdhF5bpBKr8NQ5_bGA,523
+karrio_generic-2025.5rc1.dist-info/METADATA,sha256=QU_tllNoP9AadB0PaPN-_PfZrbYrCWFC7K4Y8R9By7k,1003
+karrio_generic-2025.5rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_generic-2025.5rc1.dist-info/entry_points.txt,sha256=mvK1B8xIjTUc-b1CSXV7mlKxVW6F6qqRjW21i0COUOo,59
+karrio_generic-2025.5rc1.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
+karrio_generic-2025.5rc1.dist-info/RECORD,,

karrio_generic-2025.5rc1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

karrio_generic-2025.5rc1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[karrio.plugins]
+generic = karrio.plugins.generic:METADATA

karrio_generic-2025.5rc1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+karrio