offspot-config 2.2.4__tar.gz → 2.2.6__tar.gz

{offspot_config-2.2.4 → offspot_config-2.2.6}/CHANGELOG.md

@@ -5,6 +5,31 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.6]
+
+### Added
+
+- [branding] Added dark versions of square and horizontal logos
+- [branding] Added light+dark enabled square and horizontal SVG logos
+
+### Changed
+
+- [branding] Updated light PNG logos in accordance to Branding guidelines
+
+### Removed
+
+- [catalog] `eleda.offspot.kiwix.org` package as it is available as a ZIM
+
+## [2.2.5] - 2024-05-21
+
+### Added
+
+- [utils.dashboard] New `Reader.to_dashboard_dict()` returning dashboard-transformed download URL
+
+### Fixed
+
+- [builder] Reader download link using local URL
+
 ## [2.2.4] - 2024-05-01
 
 ### Changed

{offspot_config-2.2.4 → offspot_config-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: offspot-config
-Version: 2.2.4
+Version: 2.2.6
 Summary: Offspot Config helpers
 Project-URL: Homepage, https://github.com/offspot/offspot-config
 Project-URL: Donate, https://www.kiwix.org/en/support-us/
@@ -27,24 +27,24 @@ Requires-Dist: typeguard>=4.1.5
 Requires-Dist: urllib3<3.0,>=2.0.0
 Requires-Dist: xmltodict<0.14,>=0.13.0
 Provides-Extra: check
-Requires-Dist: pyright==1.1.358; extra == 'check'
+Requires-Dist: pyright==1.1.363; extra == 'check'
 Provides-Extra: dev
-Requires-Dist: black==24.1.1; extra == 'dev'
-Requires-Dist: coverage==7.4.1; extra == 'dev'
+Requires-Dist: black==24.4.2; extra == 'dev'
+Requires-Dist: coverage==7.5.1; extra == 'dev'
 Requires-Dist: invoke==2.2.0; extra == 'dev'
-Requires-Dist: ipython==8.20.0; extra == 'dev'
-Requires-Dist: pre-commit==3.6.0; extra == 'dev'
-Requires-Dist: pyright==1.1.358; extra == 'dev'
-Requires-Dist: pytest==8.0.0; extra == 'dev'
-Requires-Dist: ruff==0.1.15; extra == 'dev'
+Requires-Dist: ipython==8.24.0; extra == 'dev'
+Requires-Dist: pre-commit==3.7.1; extra == 'dev'
+Requires-Dist: pyright==1.1.363; extra == 'dev'
+Requires-Dist: pytest==8.2.1; extra == 'dev'
+Requires-Dist: ruff==0.4.4; extra == 'dev'
 Provides-Extra: lint
-Requires-Dist: black==24.1.1; extra == 'lint'
-Requires-Dist: ruff==0.1.15; extra == 'lint'
+Requires-Dist: black==24.4.2; extra == 'lint'
+Requires-Dist: ruff==0.4.4; extra == 'lint'
 Provides-Extra: scripts
 Requires-Dist: invoke==2.2.0; extra == 'scripts'
 Provides-Extra: test
-Requires-Dist: coverage==7.4.1; extra == 'test'
-Requires-Dist: pytest==8.0.0; extra == 'test'
+Requires-Dist: coverage==7.5.1; extra == 'test'
+Requires-Dist: pytest==8.2.1; extra == 'test'
 Description-Content-Type: text/markdown
 
 # offspot-config

{offspot_config-2.2.4 → offspot_config-2.2.6}/pyproject.toml

@@ -41,19 +41,19 @@ scripts = [
   "invoke==2.2.0",
 ]
 lint = [
-  "black==24.1.1",
-  "ruff==0.1.15",
+  "black==24.4.2",
+  "ruff==0.4.4",
 ]
 check = [
-  "pyright==1.1.358",
+  "pyright==1.1.363",
 ]
 test = [
-  "pytest==8.0.0",
-  "coverage==7.4.1",
+  "pytest==8.2.1",
+  "coverage==7.5.1",
 ]
 dev = [
-  "pre-commit==3.6.0",
-  "ipython==8.20.0",
+  "pre-commit==3.7.1",
+  "ipython==8.24.0",
   "offspot-config[scripts]",
   "offspot-config[lint]",
   "offspot-config[test]",
@@ -131,6 +131,8 @@ target-version = ['py39']
 target-version = "py39"
 line-length = 88
 src = ["src"]
+
+[lint]
 select = [
   "A",  # flake8-builtins
   # "ANN",  # flake8-annotations
@@ -209,18 +211,18 @@ unfixable = [
   "F401",
 ]
 
-[tool.ruff.isort]
+[lint.isort]
 known-first-party = ["offspot_config", "offspot_runtime"]
 known-local-folder = ["src"]
 
-[tool.ruff.flake8-bugbear]
+[lint.flake8-bugbear]
 # add exceptions to B008 for fastapi.
 extend-immutable-calls = ["fastapi.Depends", "fastapi.Query"]
 
-[tool.ruff.flake8-tidy-imports]
+[lint.flake8-tidy-imports]
 ban-relative-imports = "all"
 
-[tool.ruff.per-file-ignores]
+[lint.per-file-ignores]
 "tests/**/*" = [
   # can use magic values, assertions and relative imports
   "PLR2004", "S101", "TID252",

offspot_config-2.2.6/src/offspot_config/branding/horizontal-logo.svg

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" version="1.1" viewBox="0 0 2200 400">
+  <defs>
+    <style>
+      path {
+        fill: #000000;
+      }
+      @media (prefers-color-scheme: dark) {
+        path {
+          fill: #FFFFFF;
+        }
+      }
+      @media (prefers-color-scheme: light) {
+        path {
+          fill: #000000;
+        }
+      }
+    </style>
+  </defs>
+  <g>
+    <path d="M431.6,260.3c-2.9-13.2-25-51.3-69.6-85.1-8.3-6.3-15.5-11.4-21.6-15.5,8.8-38.3-37.5-84.3-82.9-62.7-32.6-30.7-68.8-43-102.2-42.6C66.9,55.6-1.3,147.7,72.2,235.6h0c1.2,1.4,2.4,2.8,3.5,4.1,4.7,5.7,7.9,10.8,10.6,19.6l21.8,71.7h-7.7c-7.1,0-13,5.7-13,13h29.3l49.3,23.4c3.1-6.5,0-14.1-6.1-17.1l-13-6.1h37.1c0-7.1-5.7-13-13-13h-33.8c-5.9,0-11.2-3.9-12.8-9.4l-17.3-57c-4.3-14.9,5.5-24.8,14.9-25.9,8.4-1,12.8,4.5,16.7,17.7l15.3,50.5h-7.7c-7.1,0-13,5.7-13,13h29.3l49.3,23.4c3.1-6.5,0-14.1-6.1-17.1l-13-6.1h27.3c2.8,4.7,6.1,9,10.2,13.2,25.3,25.3,66.8,25.3,92.1,0,25.3-25.3,25.3-66.8,0-92.1-25.3-25.3-66.8-25.3-92.1,0s-23.2,43.6-15.9,66h-30.8c-5.9,0-11.2-3.9-12.8-9.4l-25.5-84.1,4.3-2.4c60.7-25.5,125.6,20,170.7-23.8h.2c5.5-5.3,11.2-10.6,27.7,0,17.9,11.2,57,40.3,74.9,90,0,0,10.8-3.9,7.9-17.1h0l.2-.2ZM306.6,150.1c0-6.9-5.7-12.2-12.6-12.2s-12.6,5.5-12.6,12.6,1.8,7.1,4.3,9.4c-9-1.8-15.9-9.6-15.9-19.3s8.8-19.6,19.6-19.6,19.6,8.8,19.6,19.6-1,6.7-2.6,9.4Z"/>
+    <g>
+      <path d="M572.6,219.4l-20.2,21.8v54.2h-39.1V105.9h39.1v85.9l17.1-23.6,48.3-62.3h47.9l-67.4,84.3,69.4,105.3h-46.6l-48.7-76h.2Z"/>
+      <path d="M679.9,118.3c0-5.7,2-10.2,5.7-14,3.7-3.7,8.8-5.5,15.5-5.5s11.6,1.8,15.3,5.5c3.7,3.7,5.7,8.3,5.7,14s-2,10.4-5.7,14.1c-3.9,3.7-9,5.5-15.3,5.5s-11.4-1.8-15.3-5.5-5.7-8.3-5.7-14.1h-.2ZM719.8,295.5h-37.7v-140.9h37.7v140.9Z"/>
+      <path d="M873.2,244.4l18.5-89.8h36.3l-36,140.9h-31.4l-26.7-88.6-26.7,88.6h-31.4l-36-140.9h36.3l18.3,89.6,25.7-89.6h27.1l25.7,89.8h.2Z"/>
+      <path d="M946.5,118.3c0-5.7,2-10.2,5.7-14,3.7-3.7,8.8-5.5,15.5-5.5s11.6,1.8,15.3,5.5c3.7,3.7,5.7,8.3,5.7,14s-2,10.4-5.7,14.1c-3.9,3.7-9,5.5-15.3,5.5s-11.4-1.8-15.3-5.5-5.7-8.3-5.7-14.1h-.2ZM986.4,295.5h-37.7v-140.9h37.7v140.9Z"/>
+      <path d="M1071.1,196.7l23.8-42h40.3l-40.1,69,41.8,71.9h-40.3l-25.1-44.2-25,44.2h-40.5l41.9-71.9-39.9-69h40.3l23.2,42h-.4Z"/>
+      <path d="M1376.2,295.5h-39.1v-81.1h-76.2v81.1h-39.1V105.9h39.1v76.8h76.2v-76.8h39.1v189.6Z"/>
+      <path d="M1402,223.8c0-14,2.8-26.5,8.1-37.3,5.3-11,13.2-19.5,23.2-25.3s21.8-9,35.2-9c19.1,0,34.6,5.9,46.6,17.5,12,11.6,18.7,27.5,20,47.4v9.6c.2,21.6-5.7,38.9-17.9,52.1-12,13-28.3,19.6-48.5,19.6s-36.5-6.5-48.5-19.5c-12.2-13-18.1-30.7-18.1-53v-2ZM1439.7,226.5c0,13.4,2.6,23.6,7.5,30.7,5.1,7.1,12.2,10.6,21.6,10.6s16.3-3.5,21.4-10.4c5.1-7.1,7.7-18.3,7.7-33.6s-2.6-23.4-7.7-30.5c-5.1-7.3-12.4-10.8-21.6-10.8s-16.3,3.5-21.4,10.8c-5.1,7.3-7.5,18.3-7.5,33.4v-.2Z"/>
+      <path d="M1603.6,120v34.6h24.2v27.5h-24.2v70.3c0,5.3,1,8.8,2.9,11.2,2,2.2,5.9,3.3,11.4,3.3s7.9-.4,11-1v28.5c-7.5,2.2-14.9,3.3-22.8,3.3-26.3,0-39.9-13.4-40.3-39.9v-75.8h-20.6v-27.5h20.6v-34.6h37.7Z"/>
+      <path d="M1725,256.6c0-4.5-2.4-8.3-6.9-10.8s-11.8-5.1-22-7.1c-33.6-7.1-50.3-21.2-50.3-42.6s5.1-23,15.5-31.2c10.4-8.4,24-12.6,40.7-12.6s32.2,4.1,42.8,12.6c10.8,8.4,16.1,19.5,16.1,32.8h-37.5c0-5.3-1.8-9.8-5.3-13.4s-8.8-5.3-16.3-5.3-11.2,1.4-14.7,4.3-5.3,6.5-5.3,11,2,7.5,5.9,10c3.9,2.6,10.6,4.7,20,6.7s17.3,3.9,23.8,6.3c19.8,7.3,29.9,19.8,29.9,37.9s-5.5,23.2-16.5,31.2c-11,7.9-25.3,12-42.6,12s-22.2-2.2-31.4-6.3c-9.2-4.1-16.3-10-21.6-17.3s-7.9-15.3-7.9-23.8h35.8c.4,6.7,2.8,11.8,7.5,15.3,4.5,3.5,10.8,5.3,18.5,5.3s12.6-1.4,16.3-4.1c3.7-2.8,5.5-6.3,5.5-10.8l.2-.2Z"/>
+      <path d="M1912.6,226.3c0,21.6-4.9,39.1-14.7,52.1-9.8,13-23.2,19.6-39.9,19.6s-25.7-4.9-34.6-14.9v66.4h-37.5v-195.1h35l1.4,13.8c9-11,21-16.3,35.8-16.3s30.8,6.5,40.5,19.3c9.6,12.8,14.5,30.5,14.5,53v2l-.4.2ZM1874.9,223.6c0-13.2-2.4-23.2-6.9-30.3-4.7-7.1-11.4-10.6-20.2-10.6s-19.8,4.5-24.4,13.6v57.8c4.5,9.2,12.8,14,24.6,14,17.9,0,26.9-14.7,26.9-44.2v-.2Z"/>
+      <path d="M1930.1,223.8c0-14,2.8-26.5,8.1-37.3,5.3-11,13.2-19.5,23.2-25.3s21.8-9,35.2-9c19.1,0,34.6,5.9,46.6,17.5,12,11.6,18.7,27.5,20,47.4v9.6c.2,21.6-5.7,38.9-17.9,52.1-12,13-28.3,19.6-48.5,19.6s-36.5-6.5-48.5-19.5c-12.2-13-18.1-30.7-18.1-53v-2ZM1967.6,226.5c0,13.4,2.6,23.6,7.5,30.7,5.1,7.1,12.2,10.6,21.6,10.6s16.3-3.5,21.4-10.4c5.1-7.1,7.7-18.3,7.7-33.6s-2.6-23.4-7.7-30.5c-5.1-7.3-12.4-10.8-21.6-10.8s-16.3,3.5-21.4,10.8c-5.1,7.3-7.5,18.3-7.5,33.4v-.2Z"/>
+      <path d="M2131.7,120v34.6h24.2v27.5h-24.2v70.3c0,5.3,1,8.8,2.9,11.2,2,2.2,5.9,3.3,11.4,3.3s7.9-.4,11-1v28.5c-7.5,2.2-14.9,3.3-22.8,3.3-26.3,0-39.9-13.4-40.3-39.9v-75.8h-20.6v-27.5h20.6v-34.6h37.7Z"/>
+    </g>
+  </g>
+</svg>

offspot_config-2.2.6/src/offspot_config/branding/square-logo.svg

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg version="1.1" viewBox="0 0 400 400" xmlns="http://www.w3.org/2000/svg">
+ <defs>
+    <style>
+      path {
+        fill: #000000;
+      }
+      @media (prefers-color-scheme: dark) {
+        path {
+          fill: #FFFFFF;
+        }
+      }
+      @media (prefers-color-scheme: light) {
+        path {
+          fill: #000000;
+        }
+      }
+    </style>
+ </defs>
+ <g>
+   <path d="m381.29 260.3c-2.6281-13.2-22.656-51.3-63.075-85.1-7.5219-6.3-14.047-11.4-19.575-15.5 7.975-38.3-33.984-84.3-75.128-62.7-29.544-30.7-62.35-43-92.619-42.6-80.113 1.2-141.92 93.3-75.309 181.2 1.0875 1.4 2.175 2.8 3.1719 4.1 4.2594 5.7 7.1594 10.8 9.6063 19.6l19.756 71.7h-6.9781c-6.4344 0-11.781 5.7-11.781 13h26.553l44.678 23.4c2.8094-6.5 0-14.1-5.5281-17.1l-11.781-6.1h33.622c0-7.1-5.1656-13-11.781-13h-30.631c-5.3469 0-10.15-3.9-11.6-9.4l-15.678-57c-3.8969-14.9 4.9844-24.8 13.503-25.9 7.6125-1 11.6 4.5 15.134 17.7l13.866 50.5h-6.9781c-6.4344 0-11.781 5.7-11.781 13h26.553l44.678 23.4c2.8094-6.5 0-14.1-5.5281-17.1l-11.781-6.1h24.741c2.5375 4.7 5.5281 9 9.2438 13.2 22.928 25.3 60.538 25.3 83.466 0 22.928-25.3 22.928-66.8 0-92.1-22.928-25.3-60.538-25.3-83.466 0-22.928 25.3-21.025 43.6-14.409 66h-27.913c-5.3469 0-10.15-3.9-11.6-9.4l-23.109-84.1 3.8969-2.4c55.009-25.5 113.83 20 154.7-23.8h0.18125c4.9844-5.3 10.15-10.6 25.103 0 16.222 11.2 51.656 40.3 67.878 90 0 0 9.7875-3.9 7.1594-17.1l0.18125-0.2zm-113.28-110.2c0-6.9-5.1656-12.2-11.419-12.2s-11.419 5.5-11.419 12.6 1.6313 7.1 3.8969 9.4c-8.1563-1.8-14.409-9.6-14.409-19.3s7.975-19.6 17.763-19.6c9.7875 0 17.763 8.8 17.763 19.6s-0.90625 6.7-2.3562 9.4z" />
+  </g>
+</svg>

{offspot_config-2.2.4 → offspot_config-2.2.6}/src/offspot_config/builder.py

@@ -294,7 +294,7 @@ class ConfigBuilder:
 
         if self.dashboard_readers:
             payload["readers"] = [
-                reader.to_dict()
+                reader.to_dashboard_dict(download_fqdn=f"{ZIMDL_PREFIX}.{self.fqdn}")
                 for reader in sorted(self.dashboard_readers, key=Reader.sort)
             ]
 

{offspot_config-2.2.4 → offspot_config-2.2.6}/src/offspot_config/catalog.json

@@ -283,25 +283,6 @@
         },
         "via": "zip"
     },
-    {
-        "ident": "eleda.offspot.kiwix.org",
-        "domain": "eleda",
-        "kind": "files",
-        "title": "Les mathématiques du primaire",
-        "description": "Les mathématiques pour l'école primaire avec plus 600 activités randomisées du CP au CM2.",
-        "languages": [
-            "fra"
-        ],
-        "tags": [],
-        "icon_url": "https://drive.offspot.it/eleda/icon_zim.png",
-        "download_url": "https://drive.offspot.it/eleda/eleda_fr_fo-offline_2023-10.zip",
-        "download_size": 83684857,
-        "download_checksum": {
-            "algo": "md5",
-            "value": "c8ad28bfd8e5a0005ad128c9d09dd5c6"
-        },
-        "via": "zip"
-    },
     {
         "ident": "eleda-android.offspot.kiwix.org",
         "domain": "eleda-android",

{offspot_config-2.2.4 → offspot_config-2.2.6}/src/offspot_config/utils/dashboard.py

@@ -30,6 +30,11 @@ class Reader(NamedTuple):
 
         return {field: value_or_dict(getattr(self, field)) for field in self._fields}
 
+    def to_dashboard_dict(self, download_fqdn: str) -> dict[str, str | int]:
+        data = self.to_dict()
+        data["download_url"] = f"//{download_fqdn}/{data['filename']!s}"
+        return data
+
     @property
     def order(self) -> int:
         """sort-usable order based on reader's platform popularity"""

offspot_config-2.2.6/src/offspot_runtime/__about__.py

@@ -0,0 +1 @@
+__version__ = "2.2.6"

{offspot_config-2.2.4 → offspot_config-2.2.6}/tests/test_reader.py

@@ -27,8 +27,8 @@ REALISTIC_VALUES = [
     ),
     (
         "macos",
-        "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
-        "kiwix-desktop-macos_3.1.0.dmg",
+        "https://download.kiwix.org/release/kiwix-macos/kiwix-macos_3.1.0.dmg",
+        "kiwix-macos_3.1.0.dmg",
         16051402,
         "747fd0841b56d2d5158e0e65646b1be1",
     ),
@@ -47,8 +47,8 @@ REALISTIC_VALUES = [
             "kiwix-3.9.1.apk",
         ),
         (
-            "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
-            "kiwix-desktop-macos_3.1.0.dmg",
+            "https://download.kiwix.org/release/kiwix-macos/kiwix-macos_3.1.0.dmg",
+            "kiwix-macos_3.1.0.dmg",
         ),
         (
             "https://download.kiwix.org/release/kiwix-desktop/kiwix-desktop_x86_64_2.3.1-4.appimage",
@@ -201,14 +201,14 @@ def test_sort_order():
         ),
         (
             "macos",
-            "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
+            "https://download.kiwix.org/release/kiwix-macos/kiwix-macos_3.1.0.dmg",
             None,
             None,
             None,
             {
                 "platform": "macos",
-                "download_url": "https://download.kiwix.org/release/kiwix-desktop-macos/kiwix-desktop-macos_3.1.0.dmg",
-                "filename": "kiwix-desktop-macos_3.1.0.dmg",
+                "download_url": "https://download.kiwix.org/release/kiwix-macos/kiwix-macos_3.1.0.dmg",
+                "filename": "kiwix-macos_3.1.0.dmg",
                 "size": 16051402,
                 "checksum": None,
             },

offspot_config-2.2.4/src/offspot_runtime/__about__.py

@@ -1 +0,0 @@
-__version__ = "2.2.4"