Skip to main content

A modern, pythonic Katana Manufacturing ERP API client with automatic retries, rate limiting, and smart pagination

Project description

Katana Manufacturing ERP - API Ecosystem

Multi-language client ecosystem for the Katana Manufacturing ERP API. Production-ready clients with automatic resilience, rate limiting, and pagination.

Python 3.12+ TypeScript OpenAPI 3.1.0 CI codecov

Packages

Package Language Version Description
katana-openapi-client Python 0.41.0 Full-featured API client with transport-layer resilience
katana-mcp-server Python 0.25.0 Model Context Protocol server for AI assistants
katana-openapi-client TypeScript 0.0.1 TypeScript/JavaScript client with full type safety

Features Comparison

Feature Python Client TypeScript Client MCP Server
Automatic retries Yes Yes Yes (via Python client)
Rate limit handling Yes Yes Yes
Auto-pagination Yes Yes Yes
Type safety Full (Pydantic) Full (TypeScript) Full (Pydantic)
Sync + Async Yes Async only Async only
Browser support No Yes No
AI Integration - - Claude, Cursor, etc.

Quick Start

Python Client

pip install katana-openapi-client
import asyncio
from katana_public_api_client import KatanaClient
from katana_public_api_client.api.product import get_all_products

async def main():
    async with KatanaClient() as client:
        response = await get_all_products.asyncio_detailed(client=client)
        products = response.parsed.data
        print(f"Found {len(products)} products")

asyncio.run(main())

TypeScript Client

npm install katana-openapi-client
import { KatanaClient } from 'katana-openapi-client';

const client = await KatanaClient.create();
const response = await client.get('/products');
const { data } = await response.json();
console.log(`Found ${data.length} products`);

MCP Server (Claude Desktop)

pip install katana-mcp-server

Add to Claude Desktop config (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "katana": {
      "command": "uvx",
      "args": ["katana-mcp-server"],
      "env": {
        "KATANA_API_KEY": "your-api-key-here"
      }
    }
  }
}

Configuration

All packages support the same authentication methods:

  1. Environment variable: KATANA_API_KEY
  2. .env file: Create with KATANA_API_KEY=your-key
  3. Direct parameter: Pass api_key to client constructor
# .env file
KATANA_API_KEY=your-api-key-here
KATANA_BASE_URL=https://api.katanamrp.com/v1  # Optional

API Coverage

All clients provide access to the complete Katana API:

Category Endpoints Description
Products & Inventory 25+ Products, variants, materials, stock levels
Orders 20+ Sales orders, purchase orders, fulfillment
Manufacturing 15+ BOMs, manufacturing orders, operations
Business Relations 10+ Customers, suppliers, addresses
Configuration 6+ Locations, webhooks, custom fields

Total: 76+ endpoints with 150+ fully-typed data models

Project Structure

katana-openapi-client/               # Monorepo root
├── pyproject.toml                   # Workspace configuration (uv)
├── uv.lock                          # Unified lock file
├── docs/
│   ├── katana-openapi.yaml          # OpenAPI 3.1.0 specification
│   ├── adr/                         # Shared architecture decisions
│   └── *.md                         # Shared documentation
├── katana_public_api_client/        # Python client package
│   ├── katana_client.py             # Resilient client with retries
│   ├── api/                         # Generated API modules (76+)
│   ├── models/                      # Generated data models (150+)
│   └── docs/                        # Package documentation
├── katana_mcp_server/               # MCP server package
│   ├── src/katana_mcp/
│   │   ├── server.py                # FastMCP server
│   │   ├── tools/                   # MCP tools (12)
│   │   └── resources/               # MCP resources (5)
│   └── docs/                        # Package documentation
└── packages/
    └── katana-client/               # TypeScript client package
        ├── src/
        │   ├── client.ts            # Resilient client
        │   └── generated/           # Generated SDK
        └── docs/                    # Package documentation

Documentation

Package Documentation

Each package has its own documentation in its docs/ directory:

Architecture Decisions

Key architectural decisions are documented as ADRs (Architecture Decision Records):

Python Client ADRs (katana_public_api_client/docs/adr/):

MCP Server ADRs (katana_mcp_server/docs/adr/):

TypeScript Client ADRs (packages/katana-client/docs/adr/):

Shared/Monorepo ADRs (docs/adr/):

Shared Documentation

Development

Prerequisites

  • Python 3.12+ for Python packages
  • Node.js 18+ for TypeScript package
  • uv package manager (install)

Setup

# Clone repository
git clone https://github.com/dougborg/katana-openapi-client.git
cd katana-openapi-client

# Install all dependencies
uv sync --all-extras

# Install pre-commit hooks
uv run pre-commit install

# Create .env file
cp .env.example .env  # Add your KATANA_API_KEY

Common Commands

# Run all checks (lint, type-check, test)
uv run poe check

# Run tests
uv run poe test

# Format code
uv run poe format

# Regenerate Python client from OpenAPI spec
uv run poe regenerate-client

Commit Standards

This project uses semantic-release with conventional commits:

# Python client changes
git commit -m "feat(client): add new inventory helper"
git commit -m "fix(client): handle pagination edge case"

# MCP server changes
git commit -m "feat(mcp): add manufacturing order tools"
git commit -m "fix(mcp): improve error handling"

# TypeScript client changes
git commit -m "feat(ts): add browser support"

# Documentation only (no release)
git commit -m "docs: update README"

See MONOREPO_SEMANTIC_RELEASE.md for details.

License

MIT License - see LICENSE for details.

Contributing

Contributions welcome! See CONTRIBUTING.md for guidelines.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

katana_openapi_client-0.55.1.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

katana_openapi_client-0.55.1-py3-none-any.whl (915.5 kB view details)

Uploaded Python 3

File details

Details for the file katana_openapi_client-0.55.1.tar.gz.

File metadata

  • Download URL: katana_openapi_client-0.55.1.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for katana_openapi_client-0.55.1.tar.gz
Algorithm Hash digest
SHA256 c796fab67d900ad19ad25f669d0317e80f9092748add1d866252cf8531ad8fe8
MD5 13d8ab111d43273217c1cca634d4edb6
BLAKE2b-256 105cc90285fd64cf6a44a274c4fb9e4596c00116643c557a6f6510571e62a0ab

See more details on using hashes here.

Provenance

The following attestation bundles were made for katana_openapi_client-0.55.1.tar.gz:

Publisher: release.yml on dougborg/katana-openapi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file katana_openapi_client-0.55.1-py3-none-any.whl.

File metadata

File hashes

Hashes for katana_openapi_client-0.55.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7487faa9032fddef6766b045e0041a2bf363750d98e246ffc169177e96d40a3b
MD5 70e5bf0a8da607621ddfedc40e25fff3
BLAKE2b-256 277a9602e638ae9ce4c5ac1cfefcf0e71f4f11d6ce6361d6b3bf16875cbbb9c9

See more details on using hashes here.

Provenance

The following attestation bundles were made for katana_openapi_client-0.55.1-py3-none-any.whl:

Publisher: release.yml on dougborg/katana-openapi-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page