Initial commit

.github/workflows/python-publish.yml

@@ -0,0 +1,38 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+      - name: Install Poetry
+        run: pip install poetry
+      - name: Install dependencies
+        run: poetry install
+      - name: Build package
+        run: poetry build
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -0,0 +1,176 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python
+# Edit at https://www.toptal.com/developers/gitignore?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# End of https://www.toptal.com/developers/gitignore/api/python

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "python.analysis.typeCheckingMode": "basic"
+}

README.md

@@ -0,0 +1,3 @@
+# cursedforged
+
+CurseForge API written in Python with the help of [Pydantic](https://docs.pydantic.dev/).

cursedforged/api/base.py

@@ -0,0 +1,42 @@
+import requests
+from typing import Any
+
+from abc import ABC, abstractmethod
+
+
+class BaseAPIClient(ABC):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://api.curseforge.com",
+        client: requests.Session | None = None,
+    ):
+        self.api_key = api_key
+        self.base_url = base_url
+        self.client = client or requests.Session()
+
+    @abstractmethod
+    def get(self, endpoint: str, params: dict[str, Any] | None = None) -> Any:
+        """Send a GET request to the specified endpoint.
+
+        Args:
+            endpoint (str): The endpoint to send the request to.
+            params (dict[str, Any] | None, optional): The parameters to send with the request. Defaults to None.
+
+        Returns:
+            Any: The response data.
+        """
+        pass
+
+    @abstractmethod
+    def post(self, endpoint: str, data: dict[str, Any] | None = None) -> Any:
+        """Send a POST request to the specified endpoint.
+
+        Args:
+            endpoint (str): The endpoint to send the request to.
+            data (dict[str, Any] | None, optional): The data to send with the request. Defaults to None.
+
+        Returns:
+            Any: The response data.
+        """
+        pass

cursedforged/api/client.py

@@ -0,0 +1,84 @@
+import requests
+from typing import Any
+
+from .base import BaseAPIClient
+from .v1 import API_v1
+from .v2 import API_v2
+
+
+class APIClient(BaseAPIClient):
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://api.curseforge.com",
+        client: requests.Session | None = None,
+    ):
+        self.api_key = api_key
+        self.base_url = base_url
+        self.client = self._init_client(client)
+
+        self.v1 = API_v1(self)
+        self.v2 = API_v2(self)
+
+    def _init_client(self, client: requests.Session | None) -> requests.Session:
+        """Initialize the client with the specified client or create a new one if none is provided.
+
+        Args:
+            client (requests.Session | None, optional): The client to use. Defaults to None.
+
+        Returns:
+            requests.Session: The initialized client.
+        """
+        _client = client or requests.Session()
+        _client.headers.update(
+            {
+                "x-api-key": self.api_key,
+                "Accept": "application/json",
+            }
+        )
+        return _client
+
+    def _build_request_uri(self, endpoint: str) -> str:
+        """Build the request URI for the specified endpoint.
+
+        Args:
+            endpoint (str): The endpoint to build the URI for.
+
+        Returns:
+            str: The built URI.
+        """
+        return "{}/{}/".format(self.base_url, endpoint.strip("/"))
+
+    def get(self, endpoint: str, params: dict[str, Any] | None = None) -> Any:
+        """Send a GET request to the specified endpoint.
+
+        Args:
+            endpoint (str): The endpoint to send the request to.
+            params (dict[str, Any] | None, optional): The parameters to send with the request. Defaults to None.
+
+        Returns:
+            Any: The response data.
+        """
+        response = self.client.get(
+            url=self._build_request_uri(endpoint),
+            params=params or {},
+        )
+
+        return response.json()
+
+    def post(self, endpoint: str, data: dict[str, Any] | None = None) -> Any:
+        """Send a POST request to the specified endpoint.
+
+        Args:
+            endpoint (str): The endpoint to send the request to.
+            data (dict[str, Any] | None, optional): The data to send with the request. Defaults to None.
+
+        Returns:
+            Any: The response data.
+        """
+        response = self.client.post(
+            url=self._build_request_uri(endpoint),
+            data=data or {},
+        )
+
+        return response.json()