py-civitai-api 0.1.0__tar.gz

py_civitai_api-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.3
+Name: py-civitai-api
+Version: 0.1.0
+Summary: Unofficial Python client for the CivitAI API (sync + async)
+Keywords: civitai,api,sdk,stable-diffusion,ai,image-generation
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Dist: httpx>=0.28
+Requires-Dist: pydantic>=2.13
+Requires-Dist: typing-extensions>=4.15
+Requires-Dist: typer>=0.26.7 ; extra == 'cli'
+Requires-Dist: rich>=15 ; extra == 'cli'
+Requires-Dist: jmespath>=1.1 ; extra == 'cli'
+Requires-Dist: pytest>=9 ; extra == 'dev'
+Requires-Dist: pytest-asyncio>=1.4 ; extra == 'dev'
+Requires-Dist: pytest-cov>=7.1.0 ; extra == 'dev'
+Requires-Dist: respx>=0.23 ; extra == 'dev'
+Requires-Dist: ruff>=0.15.15 ; extra == 'dev'
+Requires-Dist: poethepoet>=0.46 ; extra == 'dev'
+Requires-Dist: mypy>=2.1.0 ; extra == 'dev'
+Requires-Dist: types-jmespath>=1.1 ; extra == 'dev'
+Requires-Dist: typer>=0.26.7 ; extra == 'dev'
+Requires-Dist: jmespath>=1.1 ; extra == 'dev'
+Requires-Dist: sphinx>=8 ; extra == 'docs'
+Requires-Dist: furo>=2024 ; extra == 'docs'
+Requires-Dist: myst-parser>=4 ; extra == 'docs'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/mcriley821/civitai-api
+Project-URL: Repository, https://github.com/mcriley821/civitai-api
+Project-URL: Bug Tracker, https://github.com/mcriley821/civitai-api/issues
+Provides-Extra: cli
+Provides-Extra: dev
+Provides-Extra: docs
+Description-Content-Type: text/markdown
+
+# civitai-api
+
+[![build](https://github.com/mcriley821/civitai-api/actions/workflows/ci.yml/badge.svg)](https://github.com/mcriley821/civitai-api/actions/workflows/ci.yml)
+
+[![codecov](https://codecov.io/gh/mcriley821/civitai-api/graph/badge.svg?token=FKOX46HFKF)](https://codecov.io/gh/mcriley821/civitai-api)
+
+Unofficial Python client for the [CivitAI API](https://developer.civitai.com/site/) — sync and async.
+
+## Install
+
+```bash
+pip install py-civitai-api
+
+# with CLI
+pip install "py-civitai-api[cli]"
+```
+
+## Quick start
+
+```python
+from civitai_api import CivitAI
+
+# api key or CIVITAI_API_KEY env var
+with CivitAI(api_key="...") as client:
+    for model in client.models.list(query="dreamshaper", limit=5).auto_paging_iter():
+        print(model.name, model.id)
+```
+
+### Async
+
+```python
+import asyncio
+from civitai_api import AsyncCivitAI
+
+async def main():
+    async with AsyncCivitAI() as client:
+        version = await client.model_versions.retrieve(12345)
+        print(version.name)
+
+asyncio.run(main())
+```
+
+### CLI
+
+```bash
+civitai auth login
+civitai models list --query dreamshaper --limit 5
+civitai models get 12345
+civitai images list --model-id 12345
+```
+
+## Development
+
+```bash
+git clone https://github.com/mcriley821/civitai-api
+cd civitai-api
+uv sync --extra dev
+uv run poe install-hooks  # install pre-commit hook (runs lint + typecheck + test)
+uv run poe check   # lint + typecheck + test
+```
+
+## Note
+
+Built with AI assistance ([Claude](https://claude.ai), Anthropic). All code is reviewed by the author.
+Not affiliated with or endorsed by CivitAI.

py_civitai_api-0.1.0/README.md

@@ -0,0 +1,65 @@
+# civitai-api
+
+[![build](https://github.com/mcriley821/civitai-api/actions/workflows/ci.yml/badge.svg)](https://github.com/mcriley821/civitai-api/actions/workflows/ci.yml)
+
+[![codecov](https://codecov.io/gh/mcriley821/civitai-api/graph/badge.svg?token=FKOX46HFKF)](https://codecov.io/gh/mcriley821/civitai-api)
+
+Unofficial Python client for the [CivitAI API](https://developer.civitai.com/site/) — sync and async.
+
+## Install
+
+```bash
+pip install py-civitai-api
+
+# with CLI
+pip install "py-civitai-api[cli]"
+```
+
+## Quick start
+
+```python
+from civitai_api import CivitAI
+
+# api key or CIVITAI_API_KEY env var
+with CivitAI(api_key="...") as client:
+    for model in client.models.list(query="dreamshaper", limit=5).auto_paging_iter():
+        print(model.name, model.id)
+```
+
+### Async
+
+```python
+import asyncio
+from civitai_api import AsyncCivitAI
+
+async def main():
+    async with AsyncCivitAI() as client:
+        version = await client.model_versions.retrieve(12345)
+        print(version.name)
+
+asyncio.run(main())
+```
+
+### CLI
+
+```bash
+civitai auth login
+civitai models list --query dreamshaper --limit 5
+civitai models get 12345
+civitai images list --model-id 12345
+```
+
+## Development
+
+```bash
+git clone https://github.com/mcriley821/civitai-api
+cd civitai-api
+uv sync --extra dev
+uv run poe install-hooks  # install pre-commit hook (runs lint + typecheck + test)
+uv run poe check   # lint + typecheck + test
+```
+
+## Note
+
+Built with AI assistance ([Claude](https://claude.ai), Anthropic). All code is reviewed by the author.
+Not affiliated with or endorsed by CivitAI.

py_civitai_api-0.1.0/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["uv_build>=0.11.19,<0.12"]
+build-backend = "uv_build"
+
+[project]
+name = "py-civitai-api"
+version = "0.1.0"
+description = "Unofficial Python client for the CivitAI API (sync + async)"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+keywords = ["civitai", "api", "sdk", "stable-diffusion", "ai", "image-generation"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.28",
+    "pydantic>=2.13",
+    "typing-extensions>=4.15",
+]
+
+[project.optional-dependencies]
+cli = ["typer>=0.26.7", "rich>=15", "jmespath>=1.1"]
+dev = [
+    "pytest>=9",
+    "pytest-asyncio>=1.4",
+    "pytest-cov>=7.1.0",
+    "respx>=0.23",
+    "ruff>=0.15.15",
+    "poethepoet>=0.46",
+    "mypy>=2.1.0",
+    "types-jmespath>=1.1",
+    "typer>=0.26.7",
+    "jmespath>=1.1",
+]
+docs = [
+    "sphinx>=8",
+    "furo>=2024",
+    "myst-parser>=4",
+]
+
+[project.scripts]
+civitai = "civitai_api.cli.main:app"
+
+[project.urls]
+Homepage = "https://github.com/mcriley821/civitai-api"
+Repository = "https://github.com/mcriley821/civitai-api"
+"Bug Tracker" = "https://github.com/mcriley821/civitai-api/issues"
+
+[tool.uv]
+package = true
+
+[tool.uv.build-backend]
+module-name = "civitai_api"
+
+[tool.ruff]
+src = ["src"]
+line-length = 120
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["PLR0913", "COM812"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "pep257"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["S101", "S106"]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+ignore_missing_imports = false
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+
+[tool.poe.tasks]
+lint = "ruff check src tests"
+format = "ruff format src tests"
+typecheck = "mypy src"
+test = "pytest tests/"
+coverage = "pytest --cov-report=term-missing --cov=civitai_api tests/"
+coverage-ci = "pytest --cov-report=xml --cov=civitai_api --cov-branch tests/"
+install-hooks = "cp scripts/pre-commit .git/hooks/pre-commit"
+docs = "sphinx-build -b html docs/source docs/build/html"
+
+[tool.poe.tasks.docs-clean]
+shell = "rm -rf docs/build"
+
+[tool.poe.tasks.check]
+sequence = ["lint", "typecheck", "test"]

py_civitai_api-0.1.0/src/civitai_api/__init__.py

@@ -0,0 +1,83 @@
+"""civitai_api — unofficial Python client for the CivitAI API."""
+
+from importlib.metadata import version as get_version
+
+__version__ = get_version("py-civitai-api")
+
+from ._internal.client import AsyncCivitAI, CivitAI
+from ._internal.exceptions import (
+    APIConnectionError,
+    APIError,
+    APITimeoutError,
+    AuthenticationError,
+    CivitAIError,
+    InternalServerError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+)
+from ._internal.oauth2 import (
+    FileTokenStore,
+    MemoryTokenStore,
+    OAuth2Config,
+    OAuth2Token,
+    Scope,
+    run_pkce_flow,
+)
+from ._internal.types import NULL
+from .types import (
+    Creator,
+    Image,
+    ImageMeta,
+    ImageTag,
+    Me,
+    Model,
+    ModelFile,
+    ModelImage,
+    ModelStats,
+    ModelVersion,
+    ModelVersionFile,
+    ModelVersionStats,
+    Tag,
+    User,
+    VaultItem,
+    VaultStatus,
+)
+
+__all__ = [
+    "NULL",
+    "APIConnectionError",
+    "APIError",
+    "APITimeoutError",
+    "AsyncCivitAI",
+    "AuthenticationError",
+    "CivitAI",
+    "CivitAIError",
+    "Creator",
+    "FileTokenStore",
+    "Image",
+    "ImageMeta",
+    "ImageTag",
+    "InternalServerError",
+    "Me",
+    "MemoryTokenStore",
+    "Model",
+    "ModelFile",
+    "ModelImage",
+    "ModelStats",
+    "ModelVersion",
+    "ModelVersionFile",
+    "ModelVersionStats",
+    "NotFoundError",
+    "OAuth2Config",
+    "OAuth2Token",
+    "PermissionDeniedError",
+    "RateLimitError",
+    "Scope",
+    "Tag",
+    "User",
+    "VaultItem",
+    "VaultStatus",
+    "__version__",
+    "run_pkce_flow",
+]