inventree-sdk 0.1.1

Python SDK for the InvenTree API

inventree-sdk

Python SDK for the InvenTree API.

It is designed to support shared integrations across projects like stocktake, inventree-importer, and picklist.

Installation

pip install inventree-sdk

Configuration

Environment variables:

INVENTREE_URL=https://inventree.example.com
INVENTREE_TOKEN=your-api-token

Compatible aliases are also supported:

• INVENTREE_API_URL
• INVENTREE_API_TOKEN

Usage

from inventree_sdk import AuthManager, InvenTreeClient, get_config

config = get_config()
auth = AuthManager(config)
client = InvenTreeClient(config, auth)

part = client.parts.find_by_name("FRAME-001")
stock = client.stock.list_for_part(part.pk, in_stock=True)

Included services

• parts
• companies
• barcodes
• bom
• pricing
• stock
• builds

Full schema coverage

The SDK now ships with a generated OpenAPI surface for the full InvenTree schema.

• Existing hand-written services remain for the most common workflows.
• Every schema operation is also attached as a generated method on the matching service.
• Missing service groups are created automatically on the client.

Examples:

stock_page = client.stock.stock_list(part=123, limit=25)
attachment_page = client.attachment.attachment_list(limit=10)
build = client.builds.build_retrieve(id=42)

Generated component models are also available:

from inventree_sdk import get_openapi_model

StockItemModel = get_openapi_model("StockItem")

GitLab CI

The repository includes a .gitlab-ci.yml pipeline that:

• runs ruff and pytest
• builds the package with python -m build
• publishes to PyPI on tagged releases

To enable publishing, add a masked GitLab CI/CD variable named PYPI_API_TOKEN with a PyPI API token value.

The publish job uploads with twine using PyPI's token-based auth on tag pipelines.

Current focus

This first version covers the endpoints already used by the local codebase:

• parts and categories
• companies and supplier parts
• barcode scan/link/unlink
• BOM items
• internal and sale prices
• stock listing, stock removal, stock count
• builds