mivia 0.1.0__tar.gz

mivia-0.1.0/.gitignore

@@ -0,0 +1,165 @@
+# ---> Node
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+!e2e/.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+.vscode
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+
+# Python
+.venv
+samples
+*.h5
+control-node/test-keys
+/monitor/node-monitor
+/monitor/node-monitor.exe
+bin
+
+#Data
+/www-data
+wasm-build
+/www/server/.idea/cody_history.xml
+/www/server/.idea/cody_project_settings.xml
+/www/shared/.idea/aws.xml
+/e2e/.idea/aws.xml
+#/ui/*
+/e2e/config/*.env
+!/e2e/config/api.env
+!/e2e/config/mail.env
+!/e2e/config/ui-config.js
+!/e2e/docker-compose.yml
+/www/server/.idea/dataSources.local.xml
+/www/server/.idea/inspectionProfiles/Project_Default.xml
+/www/server/.idea/sqldialects.xml
+/www/server/.idea/vcs.xml
+mockups
+e2e-old
+
+# Playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+/playwright/.auth/
+
+# others
+.mcp*
+.claude/
+.playwright-mcp/
+CLAUDE.md
+azure-cli.md
+results

mivia-0.1.0/.prototools

@@ -0,0 +1,2 @@
+python = "~3.12"
+uv = "~0.9"

mivia-0.1.0/.python-version

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

mivia-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MiViA Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mivia-0.1.0/PKG-INFO

@@ -0,0 +1,176 @@
+Metadata-Version: 2.4
+Name: mivia
+Version: 0.1.0
+Summary: Python API client for MiViA (Microstructure Analysis)
+Project-URL: Homepage, https://mivia.ai
+Project-URL: Documentation, https://github.com/MiViA-GmbH/mivia-api-python#readme
+Project-URL: Repository, https://github.com/MiViA-GmbH/mivia-api-python
+Project-URL: Issues, https://github.com/MiViA-GmbH/mivia-api-python/issues
+Author-email: Krzysztof Bzowski <krzysztof.bzowski@mivia.ai>
+License: MIT
+License-File: LICENSE
+Keywords: analysis,api,client,microscopy,microstructure,mivia
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: typer>=0.12.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# MiViA Python Client
+
+Python API client for MiViA (Microstructure Analysis).
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Configuration
+
+Set your API key as environment variable:
+
+```bash
+export MIVIA_API_KEY="your-api-key"
+export MIVIA_BASE_URL="https://app.mivia.ai/api"  # optional, default
+```
+
+## Usage
+
+### Async Client
+
+```python
+import asyncio
+from mivia import MiviaClient
+
+async def main():
+    async with MiviaClient() as client:
+        # List models
+        models = await client.list_models()
+        print(f"Models: {[m.display_name for m in models]}")
+
+        # High-level: analyze images
+        jobs = await client.analyze(
+            file_paths=["image1.png", "image2.png"],
+            model_id=models[0].id,
+            wait=True,
+        )
+
+        for job in jobs:
+            print(f"Job {job.id}: {job.status}")
+
+        # Download report
+        await client.download_pdf(
+            job_ids=[j.id for j in jobs],
+            output_path="report.pdf",
+        )
+
+asyncio.run(main())
+```
+
+### Sync Client
+
+```python
+from mivia import SyncMiviaClient
+
+client = SyncMiviaClient()
+
+# List models
+models = client.list_models()
+
+# Get customizations for a model
+customizations = client.get_model_customizations(models[0].id)
+
+# Upload and analyze with customization
+jobs = client.analyze(
+    file_paths=["image.png"],
+    model_id=models[0].id,
+    customization_id=customizations[0].id if customizations else None,
+)
+
+# Download report
+client.download_csv(
+    job_ids=[j.id for j in jobs],
+    output_path="report.zip",
+)
+```
+
+## CLI
+
+```bash
+# List models
+mivia models
+
+# List customizations for a model
+mivia customizations MODEL_UUID
+
+# Upload images
+mivia upload image1.png image2.png
+
+# Analyze (upload + run + wait)
+mivia analyze image.png --model MODEL_UUID
+
+# Analyze with customization (by name or UUID)
+mivia analyze image.png --model MODEL_UUID --customization "Template Name"
+
+# List available customizations for analyze
+mivia analyze --model MODEL_UUID --list-customizations
+
+# List jobs
+mivia jobs list
+
+# Get job details
+mivia jobs get JOB_UUID
+
+# Wait for jobs
+mivia jobs wait JOB_UUID1 JOB_UUID2
+
+# Download PDF report
+mivia report pdf JOB_UUID -o report.pdf
+
+# Download CSV report
+mivia report csv JOB_UUID -o report.zip --no-images
+
+# Show config
+mivia config
+```
+
+## API Reference
+
+### MiviaClient
+
+| Method | Description |
+|--------|-------------|
+| `upload_image(path)` | Upload single image |
+| `upload_images(paths)` | Upload multiple images |
+| `list_images()` | List uploaded images |
+| `delete_image(id)` | Delete image |
+| `list_models()` | List available models |
+| `get_model_customizations(id)` | Get model customizations |
+| `create_jobs(image_ids, model_id)` | Create computation jobs |
+| `get_job(id)` | Get job details with results |
+| `list_jobs()` | List jobs with pagination |
+| `wait_for_job(id)` | Poll until job completes |
+| `wait_for_jobs(ids)` | Wait for multiple jobs |
+| `download_pdf(job_ids, path)` | Download PDF report |
+| `download_csv(job_ids, path)` | Download CSV report |
+| `analyze(paths, model_id)` | High-level: upload + run + wait |

mivia-0.1.0/README.md

@@ -0,0 +1,139 @@
+# MiViA Python Client
+
+Python API client for MiViA (Microstructure Analysis).
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+## Configuration
+
+Set your API key as environment variable:
+
+```bash
+export MIVIA_API_KEY="your-api-key"
+export MIVIA_BASE_URL="https://app.mivia.ai/api"  # optional, default
+```
+
+## Usage
+
+### Async Client
+
+```python
+import asyncio
+from mivia import MiviaClient
+
+async def main():
+    async with MiviaClient() as client:
+        # List models
+        models = await client.list_models()
+        print(f"Models: {[m.display_name for m in models]}")
+
+        # High-level: analyze images
+        jobs = await client.analyze(
+            file_paths=["image1.png", "image2.png"],
+            model_id=models[0].id,
+            wait=True,
+        )
+
+        for job in jobs:
+            print(f"Job {job.id}: {job.status}")
+
+        # Download report
+        await client.download_pdf(
+            job_ids=[j.id for j in jobs],
+            output_path="report.pdf",
+        )
+
+asyncio.run(main())
+```
+
+### Sync Client
+
+```python
+from mivia import SyncMiviaClient
+
+client = SyncMiviaClient()
+
+# List models
+models = client.list_models()
+
+# Get customizations for a model
+customizations = client.get_model_customizations(models[0].id)
+
+# Upload and analyze with customization
+jobs = client.analyze(
+    file_paths=["image.png"],
+    model_id=models[0].id,
+    customization_id=customizations[0].id if customizations else None,
+)
+
+# Download report
+client.download_csv(
+    job_ids=[j.id for j in jobs],
+    output_path="report.zip",
+)
+```
+
+## CLI
+
+```bash
+# List models
+mivia models
+
+# List customizations for a model
+mivia customizations MODEL_UUID
+
+# Upload images
+mivia upload image1.png image2.png
+
+# Analyze (upload + run + wait)
+mivia analyze image.png --model MODEL_UUID
+
+# Analyze with customization (by name or UUID)
+mivia analyze image.png --model MODEL_UUID --customization "Template Name"
+
+# List available customizations for analyze
+mivia analyze --model MODEL_UUID --list-customizations
+
+# List jobs
+mivia jobs list
+
+# Get job details
+mivia jobs get JOB_UUID
+
+# Wait for jobs
+mivia jobs wait JOB_UUID1 JOB_UUID2
+
+# Download PDF report
+mivia report pdf JOB_UUID -o report.pdf
+
+# Download CSV report
+mivia report csv JOB_UUID -o report.zip --no-images
+
+# Show config
+mivia config
+```
+
+## API Reference
+
+### MiviaClient
+
+| Method | Description |
+|--------|-------------|
+| `upload_image(path)` | Upload single image |
+| `upload_images(paths)` | Upload multiple images |
+| `list_images()` | List uploaded images |
+| `delete_image(id)` | Delete image |
+| `list_models()` | List available models |
+| `get_model_customizations(id)` | Get model customizations |
+| `create_jobs(image_ids, model_id)` | Create computation jobs |
+| `get_job(id)` | Get job details with results |
+| `list_jobs()` | List jobs with pagination |
+| `wait_for_job(id)` | Poll until job completes |
+| `wait_for_jobs(ids)` | Wait for multiple jobs |
+| `download_pdf(job_ids, path)` | Download PDF report |
+| `download_csv(job_ids, path)` | Download CSV report |
+| `analyze(paths, model_id)` | High-level: upload + run + wait |

mivia-0.1.0/pyproject.toml

@@ -0,0 +1,70 @@
+[project]
+name = "mivia"
+version = "0.1.0"
+description = "Python API client for MiViA (Microstructure Analysis)"
+readme = "README.md"
+license = {text = "MIT"}
+requires-python = ">=3.11"
+authors = [
+    {name = "Krzysztof Bzowski", email = "krzysztof.bzowski@mivia.ai"},
+]
+keywords = ["mivia", "microstructure", "analysis", "api", "client", "microscopy"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Image Processing",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic>=2.0.0",
+    "pydantic-settings>=2.0.0",
+    "typer>=0.12.0",
+    "rich>=13.0.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-httpx>=0.30.0",
+    "ruff>=0.4.0",
+    "mypy>=1.10.0",
+]
+
+[project.urls]
+Homepage = "https://mivia.ai"
+Documentation = "https://github.com/MiViA-GmbH/mivia-api-python#readme"
+Repository = "https://github.com/MiViA-GmbH/mivia-api-python"
+Issues = "https://github.com/MiViA-GmbH/mivia-api-python/issues"
+
+[project.scripts]
+mivia = "mivia.cli.main:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mivia"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

mivia-0.1.0/src/mivia/__init__.py

@@ -0,0 +1,46 @@
+"""MiViA Python API client."""
+
+from mivia.client import MiviaClient
+from mivia.exceptions import (
+    AuthenticationError,
+    JobTimeoutError,
+    MiviaError,
+    NotFoundError,
+    ServerError,
+    ValidationError,
+)
+from mivia.models import (
+    CreateJobsRequest,
+    CreateReportRequest,
+    CustomizationDto,
+    ImageDto,
+    JobDto,
+    JobListResponse,
+    JobStatus,
+    ModelDto,
+)
+from mivia.sync_client import SyncMiviaClient
+
+__all__ = [
+    # Clients
+    "MiviaClient",
+    "SyncMiviaClient",
+    # Exceptions
+    "MiviaError",
+    "AuthenticationError",
+    "NotFoundError",
+    "ValidationError",
+    "ServerError",
+    "JobTimeoutError",
+    # Models
+    "ImageDto",
+    "ModelDto",
+    "CustomizationDto",
+    "JobDto",
+    "JobStatus",
+    "JobListResponse",
+    "CreateJobsRequest",
+    "CreateReportRequest",
+]
+
+__version__ = "0.1.0"

mivia-0.1.0/src/mivia/cli/__init__.py

@@ -0,0 +1 @@
+"""MiViA CLI module."""