feat: first commit

Author: z0z0r4

.github/workflows/release.yml

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*" # Push events to matching v*, i.e. v1.0, v20.15.10
+  workflow_dispatch:
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: build release distributions
+        run: |
+          just build
+
+      - name: upload dists
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  publish-pypi:
+    runs-on: ubuntu-latest
+    name: Publish to PyPI
+    if: "startsWith(github.ref, 'refs/tags/')"
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Publish release distributions to PyPI
+        run: uv publish -v
+
+  # publish-release:
+  #   runs-on: ubuntu-latest
+  #   name: Publish to GitHub
+  #   if: "startsWith(github.ref, 'refs/tags/')"
+  #   needs:
+  #     - release-build
+  #   permissions:
+  #     contents: write
+  #   steps:
+  #     - uses: actions/download-artifact@v4
+  #       with:
+  #         name: release-dists
+  #         path: dist/
+  #     - name: Get tag name
+  #       run: echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+  #     - name: Publish to GitHub
+  #       uses: softprops/action-gh-release@v2
+  #       with:
+  #         draft: true
+  #         files: dist/*
+  #         tag_name: ${{ env.RELEASE_VERSION }}

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: Unit Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  merge_group:
+  workflow_dispatch:
+
+jobs:
+  unit-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
+        architecture: ["x64"]
+    name: Python ${{ matrix.python-version }} on ${{ matrix.architecture }} unit test
+    env:
+      CURSEFORGE_API_KEY: ${{ secrets.CURSEFORGE_API_KEY }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          architecture: ${{ matrix.architecture }}
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: |
+          just ci-install
+
+      - name: Run unit tests
+        run: |
+          just test

.python-version

@@ -0,0 +1 @@
+3.12

curseforge_api_wrapper/__init__.py

@@ -0,0 +1,26 @@
+from curseforge_api_wrapper.client import Client
+from curseforge_api_wrapper.models import (
+    Mod,
+    File,
+    Fingerprint,
+    Category,
+    SearchResult,
+    FingerprintResult,
+    ModFilesResult,
+)
+
+__all__ = [
+    "Client",
+    "Mod",
+    "File",
+    "Fingerprint",
+    "Category",
+    "SearchResult",
+    "FingerprintResult",
+    "ModFilesResult",
+]
+
+# Define some metadata here:
+
+__version__ = "1.0.0"
+__author__ = "z0z0r4"

curseforge_api_wrapper/client.py

@@ -0,0 +1,206 @@
+from typing import Optional, Union, List
+from enum import Enum
+import json
+
+from curseforge_api_wrapper.models import (
+    Mod,
+    File,
+    Fingerprint,
+    Category,
+    SearchResult,
+    FingerprintResult,
+    ModFilesResult,
+)
+from curseforge_api_wrapper.network import request
+
+
+class ModLoaderType(Enum):
+    """
+    ModLoaderType
+
+    0=Any
+    1=Forge
+    2=Cauldron
+    3=LiteLoader
+    4=Fabric
+    5=Quilt
+    6=NeoForge
+    """
+
+    Any = 0
+    Forge = 1
+    Cauldron = 2
+    LiteLoader = 3
+    Fabric = 4
+    Quilt = 5
+    NeoForge = 6
+
+
+class ModsSearchSortField(Enum):
+    Featured = 1
+    Popularity = 2
+    LastUpdated = 3
+    Name = 4
+    Author = 5
+    TotalDownloads = 6
+    Category = 7
+    GameVersion = 8
+    EarlyAccess = 9
+    FeaturedReleased = 10
+    ReleasedDate = 11
+    Rating = 12
+
+
+class SortOrder(Enum):
+    Asc = "asc"
+    Desc = "desc"
+
+
+class Client:
+    def __init__(self, api_key: str, endpoint: str = "https://api.curseforge.com"):
+        self.api_key = api_key
+        self.headers = {"x-api-key": api_key, "Accept": "application/json", "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36 Edg/116.0.1938.54"}
+        self.endpoint = endpoint
+
+    def search_mods(
+        self,
+        gameId: int,
+        classId: Optional[int] = None,
+        categoryId: Optional[int] = None,
+        categoryIds: Optional[str] = None,
+        gameVersion: Optional[str] = None,
+        gameVersions: Optional[str] = None,
+        searchFilter: Optional[str] = None,
+        sortField: Optional[Union[int, ModsSearchSortField]] = None,
+        sortOrder: Optional[Union[str, SortOrder]] = None,
+        modLoaderType: Optional[Union[int, ModLoaderType]] = None,
+        modLoaderTypes: Optional[str] = None,
+        gameVersionTypeId: Optional[int] = None,
+        authorId: Optional[int] = None,
+        primaryAuthorId: Optional[int] = None,
+        slug: Optional[str] = None,
+        index: Optional[int] = None,
+        pageSize: Optional[int] = None,
+    ) -> SearchResult:
+        url = f"{self.endpoint}/v1/mods/search"
+        params = {
+            "gameId": gameId,
+            "classId": classId,
+            "categoryId": categoryId,
+            "categoryIds": categoryIds,
+            "gameVersion": gameVersion,
+            "gameVersions": gameVersions,
+            "searchFilter": searchFilter,
+            "sortField": (
+                (sortField if type(sortField) is int else sortField.value)
+                if sortField
+                else None
+            ),
+            "sortOrder": (
+                (sortOrder if type(sortOrder) is str else sortOrder.value)
+                if sortOrder
+                else None
+            ),
+            "modLoaderType": (
+                modLoaderType
+                if type(modLoaderType) is int
+                else modLoaderType.value if modLoaderType else None
+            ),
+            "modLoaderTypes": modLoaderTypes,
+            "gameVersionTypeId": gameVersionTypeId,
+            "authorId": authorId,
+            "primaryAuthorId": primaryAuthorId,
+            "slug": slug,
+            "index": index,
+            "pageSize": pageSize,
+        }
+        res = request(
+            url,
+            headers=self.headers,
+            params=params,
+        )
+        return SearchResult(**res)
+
+    def get_mod(self, modId: int) -> Mod:
+        url = f"{self.endpoint}/v1/mods/{modId}"
+        res = request(url, headers=self.headers)
+        return Mod(**res["data"])
+
+    def get_mods(self, modIds: List[int]) -> List[Mod]:
+        url = f"{self.endpoint}/v1/mods"
+        res = request(url, method="POST", headers=self.headers, json={"modIds": modIds})
+        return [Mod(**item) for item in res["data"]]
+
+    def get_mod_files(
+        self,
+        modId: int,
+        gameVersion: Optional[str] = None,
+        modLoaderType: Optional[Union[int, ModLoaderType]] = None,
+        gameVersionTypeId: Optional[int] = None,
+        index: Optional[int] = None,
+        pageSize: Optional[int] = None,
+    ) -> ModFilesResult:
+        """
+        Get mod files
+        """
+        url = f"{self.endpoint}/v1/mods/{modId}/files"
+        res = request(
+            url,
+            headers=self.headers,
+            json={
+                "gameVersion": gameVersion,
+                "modLoaderType": (
+                    modLoaderType
+                    if type(modLoaderType) is int
+                    else modLoaderType.value if modLoaderType else None
+                ),
+                "gameVersionTypeId": gameVersionTypeId,
+                "index": index,
+                "pageSize": pageSize,
+            },
+        )
+        return ModFilesResult(**res)
+
+    def get_file(self, modId: int, fileId: int) -> File:
+        url = f"{self.endpoint}/v1/mods/{modId}/files/{fileId}"
+        res = request(url, headers=self.headers)
+        return File(**res["data"])
+
+    def get_files(self, fileIds: List[int]) -> List[File]:
+        url = f"{self.endpoint}/v1/mods/files"
+        res = request(
+            url, method="POST", headers=self.headers, json={"fileIds": fileIds}
+        )
+        return [File(**item) for item in res["data"]]
+
+    def get_file_download_url(self, modId: int, fileId: int) -> str:
+        url = f"{self.endpoint}/v1/mods/{modId}/files/{fileId}/download-url"
+        res = request(url, headers=self.headers)
+        return res["data"]
+
+    def get_fingerprint(
+        self, fingerprints: List[int], gameId: Optional[int] = None
+    ) -> Fingerprint:
+        url = (
+            f"{self.endpoint}/v1/fingerprints"
+            if not gameId
+            else f"{self.endpoint}/v1/fingerprints/{gameId}"
+        )
+        data = {"fingerprints": fingerprints}
+        res = request(url, method="POST", headers=self.headers, json=data)
+        return FingerprintResult(**res["data"])
+
+
+    def get_categories(
+        self,
+        gameId: int,
+        classId: Optional[int] = None,
+        classesOnly: Optional[bool] = False,
+    ) -> List[Category]:
+        url = f"{self.endpoint}/v1/categories"
+        res = request(
+            url,
+            headers=self.headers,
+            params={"gameId": gameId, "classId": classId, "classesOnly": classesOnly},
+        )
+        return [Category(**item) for item in res["data"]]