Werk24 Python Client

Unlock manufacturing intelligence from technical drawings with AI.

Table of Contents

• Overview
• Why Werk24?
• Features
• Applications
• Installation
• Dependency Management
• Quick Start
• Documentation
• Community & Support
• Contributing
• License

Overview

Werk24 provides AI-powered solutions for extracting and interpreting technical drawings. This Python client enables easy interaction with the Werk24 API for processing technical drawings efficiently. The API gives you access to the following structured data:

• Meta Data: Drawing ID, Part ID, Designation, General Tolerances, General Roughness, Material, Weight, Bill of Material (incl. Fasteners), Revision Table, Languages and Notes.
• Features: Dimensions incl. Tolerances, Threads, Bores, Chamfers, Roughnesses, GDnTs, Radii, Undercuts, Key Slots, Center Holes, Fasteners.
• Insights: Manufacturing Method, Postprocesses, Input Geometry, Output Geometry.
• Redaction: Redact information from Technical Drawings.

👉 Visit werk24.io to learn more or request a demo.

Why Werk24?

• Accelerate Quoting – Generate prices from 2D drawings in seconds.
• Reduce Manual Entry – Automatically capture metadata and dimensions.
• Speed Up Supplier Scouting – Match drawings with capable vendors.
• Protect IP – Anonymize sensitive details before sharing.
• Boost Productivity – Let engineers focus on design, not data extraction.

Features

• Automated Extraction: Retrieve metadata, dimensions, and annotations from technical drawings.
• Fast Processing: Optimized API calls for efficient inference.
• Seamless Integration: Works with Python-based workflows for manufacturing, CAD, and ERP systems.
• JSON Output: Standardized response format for easy processing.

Applications

Harness Werk24 for:

• Instant Pricing: Automate 2D drawing-based quoting.
• Feasibility Checks: Evaluate RFQs efficiently.
• Configurator Auto-Fill: Populate online configurators with minimal input.
• Drawing Anonymization: Protect sensitive data in technical drawings.
• Supplier Scouting: Automate vendor selection for specific requirements.
• ERP Registration: Streamline incoming RFQ registrations.
• Structured Archiving: Organize drawings with metadata extraction.

Installation

Pip installation

pip install werk24    # install the library
werk24 init           # paste your API token; it is saved to ~/.werk24 and found from any folder

Calling the API needs an API token and is billed pay as you go. Sign up for the Werk24 API, then create a token on the API tokens page of the Werk24 console. werk24 init asks for the token and stores it for the client. On a server or in CI, set the W24TECHREAD_AUTH_TOKEN environment variable instead.

To see what Werk24 reads from a drawing before you sign up, try the free browser demo.

To let the CLI show the sheet and view images it receives (werk24 techread --ask-sheet-images / --ask-view-images), install the images extra, which adds Pillow:

pip install "werk24[images]"

Without it, those options do not show the images and still print the other results.

Where the client looks for your API token

The client uses the first token it finds, in this order:

1. The token argument: Werk24Client(token="...").
2. .werk24 in the folder the script is started from.
3. ~/.werk24 in your home folder. This is where werk24 init saves the token.
4. werk24_license.txt in the folder the script is started from.
5. ~/werk24_license.txt in your home folder.
6. The environment variable W24TECHREAD_AUTH_TOKEN.

The environment variable suits CI jobs and containers, where no token file exists. On a machine that has a token file, the file is used instead. When no token is found, the error lists every place the client looked. werk24 health-check shows which token is in use and where it was read from.

Dependency Management

Overview

The werk24 library uses a flexible dependency management strategy designed to minimize conflicts with other packages in your environment. We specify minimum versions for dependencies based on required features and security fixes, but avoid restrictive upper bounds that can cause installation conflicts.

Why Minimum Versions?

Each minimum version requirement exists for a specific reason:

• Security Fixes: Dependencies like cryptography>=44.0.0 require minimum versions that include critical security patches
• Required Features: Some dependencies introduced features we rely on in specific versions
• API Stability: Minimum versions ensure the APIs we use are available and stable

Philosophy

We follow these principles:

以上为 README 的开头部分。其余内容请阅读原文。 查看完整 README ↗