mcarchive-api 0.1.0__tar.gz

mcarchive_api-0.1.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: mcarchive-api
+Version: 0.1.0
+Summary: Unofficial library to help you consume the MCArchive API
+Keywords: minecraft,http,api,json
+Author: 红温的鼠鼠7891
+Author-email: 红温的鼠鼠7891 <pystart@qq.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: urllib3>=2.8.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# MCArchive API for Python
+
+## 简介
+
+这是一个允许开发者与MCArchive API交互的Python库，使用[`httpx`](https://pypi.org/project/httpx/)进行API交互，[`urllib`](https://pypi.org/project/urllib/)库作为变量转URL参数。
+
+## 安装
+
+通过`pip`包管理器安装：
+
+```bash
+pip install mcarchive-api
+poetry install mcarchive-api #或者使用Poetry
+uv pip install mcarchive-api #或者使用uv
+```
+
+你也可以下载轮子并安装：
+
+```bash
+pip install ./mcarchive_api-x.x.x-py3-none-any.whl
+```
+
+或者克隆Git仓库并构建轮子：
+
+```bash
+git clone https://github.com/AngryMouse7891/mcarchive-api-python.git
+cd mcarchive-api-python
+uv build
+```
+
+## 使用方法
+
+以下是该库所有模块的描述：
+
+- `mcarchive_api.default`：获取Minecraft游戏版本和作者
+
+- `mcarchive_api.mods`：获取所有模组以及通过特定slug获取
+
+- `mcarchive_api.files`：通过文件名/SHA256哈希值获取文件
+
+比如获取所有Minecraft游戏版本：
+
+```python
+from mcarchive_api.default import get_game_versions
+
+print(f'Game Versions: {get_game_versions()}')
+```
+
+## 使用的依赖
+
+| 包名                                          | 最新版本                                       | 描述                        |
+| ------------------------------------------- | ------------------------------------------ | ------------------------- |
+| [`httpx`](https://pypi.org/project/httpx)   | ![latest](https://img.shields.io/pypi/v/httpx)   | HTTP客户端                   |
+| [`urllib3`](https://pypi.org/project/httpx) | ![latest](https://img.shields.io/pypi/v/urllib3) | 带有线程安全连接池、文件上传等功能的 HTTP 库 |
+
+## 开源许可
+
+使用[MIT许可证](https://choosealicense.com/zh/licenses/mit/)。

mcarchive_api-0.1.0/README.md

@@ -0,0 +1,58 @@
+# MCArchive API for Python
+
+## 简介
+
+这是一个允许开发者与MCArchive API交互的Python库，使用[`httpx`](https://pypi.org/project/httpx/)进行API交互，[`urllib`](https://pypi.org/project/urllib/)库作为变量转URL参数。
+
+## 安装
+
+通过`pip`包管理器安装：
+
+```bash
+pip install mcarchive-api
+poetry install mcarchive-api #或者使用Poetry
+uv pip install mcarchive-api #或者使用uv
+```
+
+你也可以下载轮子并安装：
+
+```bash
+pip install ./mcarchive_api-x.x.x-py3-none-any.whl
+```
+
+或者克隆Git仓库并构建轮子：
+
+```bash
+git clone https://github.com/AngryMouse7891/mcarchive-api-python.git
+cd mcarchive-api-python
+uv build
+```
+
+## 使用方法
+
+以下是该库所有模块的描述：
+
+- `mcarchive_api.default`：获取Minecraft游戏版本和作者
+
+- `mcarchive_api.mods`：获取所有模组以及通过特定slug获取
+
+- `mcarchive_api.files`：通过文件名/SHA256哈希值获取文件
+
+比如获取所有Minecraft游戏版本：
+
+```python
+from mcarchive_api.default import get_game_versions
+
+print(f'Game Versions: {get_game_versions()}')
+```
+
+## 使用的依赖
+
+| 包名                                          | 最新版本                                       | 描述                        |
+| ------------------------------------------- | ------------------------------------------ | ------------------------- |
+| [`httpx`](https://pypi.org/project/httpx)   | ![latest](https://img.shields.io/pypi/v/httpx)   | HTTP客户端                   |
+| [`urllib3`](https://pypi.org/project/httpx) | ![latest](https://img.shields.io/pypi/v/urllib3) | 带有线程安全连接池、文件上传等功能的 HTTP 库 |
+
+## 开源许可
+
+使用[MIT许可证](https://choosealicense.com/zh/licenses/mit/)。

mcarchive_api-0.1.0/pyproject.toml

@@ -0,0 +1,37 @@
+[project]
+name = "mcarchive-api"
+version = "0.1.0"
+description = "Unofficial library to help you consume the MCArchive API"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.14"
+dependencies = [
+    "httpx>=0.28.1",
+    "urllib3>=2.8.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+keywords = [
+    "minecraft",
+    "http",
+    "api",
+    "json",
+]
+
+[[project.authors]]
+name = "红温的鼠鼠7891"
+email = "pystart@qq.com"
+
+[project.scripts]
+mcarchive-api = "mcarchive_api:main"
+
+[[tool.uv.index]]
+url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"
+default = true
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

mcarchive_api-0.1.0/pyproject.toml.orig

@@ -0,0 +1,31 @@
+[project]
+name = "mcarchive-api"
+version = "0.1.0"
+description = "Unofficial library to help you consume the MCArchive API"
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "红温的鼠鼠7891", email = "pystart@qq.com" }
+]
+requires-python = ">=3.14"
+dependencies = [
+    "httpx>=0.28.1",
+    "urllib3>=2.8.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+keywords = ["minecraft", "http", "api", "json"]
+
+[project.scripts]
+mcarchive-api = "mcarchive_api:main"
+
+[[tool.uv.index]]
+url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"
+default = true
+
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13.0"]
+build-backend = "uv_build"

mcarchive_api-0.1.0/src/mcarchive_api/__init__.py

@@ -0,0 +1,4 @@
+from importlib.metadata import version
+
+def main() -> None:
+    print(f"mcarchive-api-python v{version("wheel")}")

mcarchive_api-0.1.0/src/mcarchive_api/default.py

@@ -0,0 +1,17 @@
+import httpx
+
+def get_authors(x_fields:str="{id,name}",headers:dict={"Accept":"application/json"}) -> list:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/authors",headers=headers_1)
+    return response.json()
+
+def get_game_versions(x_fields:str="{id,name}",headers:dict={"Accept":"application/json"}) -> list:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/game_versions",headers=headers_1)
+    return response.json()

mcarchive_api-0.1.0/src/mcarchive_api/files.py

@@ -0,0 +1,17 @@
+import httpx
+
+def get_files_by_filename(filename:str,x_fields:str="{}",headers:dict={"Accept":"application/json"}) -> dict:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/files/by_filename/"+filename,headers=headers_1)
+    return response.json()
+
+def get_files_by_hash_sha256(shasum:str,x_fields:str="{}",headers:dict={"Accept":"application/json"}) -> dict:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/files/by_hash/sha256/"+shasum,headers=headers_1)
+    return response.json()

mcarchive_api-0.1.0/src/mcarchive_api/mods.py

@@ -0,0 +1,27 @@
+import httpx
+from urllib.parse import urlencode
+
+def build_query(params: dict) -> str:
+    return "?" + urlencode(params)
+
+def get_mods(keyword:str="",game_version:str="",author:str="",x_fields:str="{slug,name}",headers:dict={"Accept":"application/json"}) -> list:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    params = {
+        "keyword": keyword,
+        "game_version": game_version,
+        "author": author
+    }
+    query_str = build_query(params)
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/mods/"+query_str,headers=headers_1)
+    return response.json()
+
+def get_mods_by_slug(slug:str,x_fields:str="{}",headers:dict={"Accept":"application/json"}) -> dict:
+    headers_1 = {
+        "X-Fields": x_fields,
+    }
+    headers_1.update(headers)
+    response=httpx.get("https://mcarchive.net/api/v1/mods/by_slug/"+slug,headers=headers_1)
+    return response.json()