# curseforge-api-wrapper
`curseforge_api_wrapper` 是一个用于与 Curseforge API 交互的 Python 包。它提供了方便的客户端类和方法来访问 Curseforge 的各种 API 端点。
特别指出提供了所有返回值的 Pydantic 封装，便于调用。
## Installation
```bash
pip install curseforge-api-wrapper
```
## Usage
```python
from curseforge_api_wrapper import Client
# Initialize client with your API key
client = Client(api_key="your-api-key")
# Search for mods
results = client.search_mods(gameId=432, pageSize=10, searchFilter="fabric-api")
# Get specific mod
mod = client.get_mod(306612)
# Get mod files
files = client.get_mod_files(306612)
# Get specific file
file = client.get_file(306612, 6113566)
# Get file download URL
url = client.get_file_download_url(306612, 6113566)
# Get fingerprints
fingerprints = client.get_fingerprint([3379185284, 2253581192])
# Get categories
categories = client.get_categories(gameId=432)
```
Raw data
{
"_id": null,
"home_page": null,
"name": "curseforge-api-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "api, curseforge, mcinecraft, python, wrapper",
"author": null,
"author_email": "z0z0r4 <z0z0r4@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/3c/72/a869d37a5534395c360c94bab981605ddee7329948c12ebcb8615ad3dcb0/curseforge_api_wrapper-1.0.1.tar.gz",
"platform": null,
"description": "# curseforge-api-wrapper\n\n\n\n`curseforge_api_wrapper` \u662f\u4e00\u4e2a\u7528\u4e8e\u4e0e Curseforge API \u4ea4\u4e92\u7684 Python \u5305\u3002\u5b83\u63d0\u4f9b\u4e86\u65b9\u4fbf\u7684\u5ba2\u6237\u7aef\u7c7b\u548c\u65b9\u6cd5\u6765\u8bbf\u95ee Curseforge \u7684\u5404\u79cd API \u7aef\u70b9\u3002\n\n\u7279\u522b\u6307\u51fa\u63d0\u4f9b\u4e86\u6240\u6709\u8fd4\u56de\u503c\u7684 Pydantic \u5c01\u88c5\uff0c\u4fbf\u4e8e\u8c03\u7528\u3002\n\n## Installation\n\n```bash\npip install curseforge-api-wrapper\n```\n\n## Usage\n\n```python\nfrom curseforge_api_wrapper import Client\n\n# Initialize client with your API key\nclient = Client(api_key=\"your-api-key\")\n\n# Search for mods\nresults = client.search_mods(gameId=432, pageSize=10, searchFilter=\"fabric-api\")\n\n# Get specific mod\nmod = client.get_mod(306612)\n\n# Get mod files\nfiles = client.get_mod_files(306612)\n\n# Get specific file\nfile = client.get_file(306612, 6113566)\n\n# Get file download URL\nurl = client.get_file_download_url(306612, 6113566)\n\n# Get fingerprints\nfingerprints = client.get_fingerprint([3379185284, 2253581192])\n\n# Get categories\ncategories = client.get_categories(gameId=432)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python wrapper for Curseforge API with Pydantic Model",
"version": "1.0.1",
"project_urls": {
"Documentation": "https://github.com/mcmod-info-mirror/curseforge-api-wrapper",
"Homepage": "https://github.com/mcmod-info-mirror/curseforge-api-wrapper",
"Issues": "https://github.com/mcmod-info-mirror/curseforge-api-wrapper/issues",
"Repository": "https://github.com/mcmod-info-mirror/curseforge-api-wrapper"
},
"split_keywords": [
"api",
" curseforge",
" mcinecraft",
" python",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "615c855bc1fe34260d8c6e2507bb9447abe40a7b169fe68b3b4f5ae1cdad5014",
"md5": "9bae7713bc23b2c8c871c59f8c2d34de",
"sha256": "fdb044ea52a87b660da8e4430619a9b564313e902bcecbe3ceee4face59ef9cc"
},
"downloads": -1,
"filename": "curseforge_api_wrapper-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bae7713bc23b2c8c871c59f8c2d34de",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7841,
"upload_time": "2025-01-25T03:56:08",
"upload_time_iso_8601": "2025-01-25T03:56:08.217988Z",
"url": "https://files.pythonhosted.org/packages/61/5c/855bc1fe34260d8c6e2507bb9447abe40a7b169fe68b3b4f5ae1cdad5014/curseforge_api_wrapper-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3c72a869d37a5534395c360c94bab981605ddee7329948c12ebcb8615ad3dcb0",
"md5": "f78df198cfd4768253ca0b70b698899e",
"sha256": "cdb1953dc5514315a3fe030d650d8f7edb3cf2d23912a27736132476504c2b73"
},
"downloads": -1,
"filename": "curseforge_api_wrapper-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f78df198cfd4768253ca0b70b698899e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 23070,
"upload_time": "2025-01-25T03:56:09",
"upload_time_iso_8601": "2025-01-25T03:56:09.307086Z",
"url": "https://files.pythonhosted.org/packages/3c/72/a869d37a5534395c360c94bab981605ddee7329948c12ebcb8615ad3dcb0/curseforge_api_wrapper-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-25 03:56:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mcmod-info-mirror",
"github_project": "curseforge-api-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "curseforge-api-wrapper"
}
JSON
