Metadata-Version: 2.5
Name: freecad-typings
Version: 26.3.0.dev2
Summary: Type stubs for FreeCAD Python API
Author: FreeCAD Project
License-Expression: LGPL-2.1-or-later
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# freecad-typings

Type stubs for the [FreeCAD] Python API (version `26.3.0.dev2`).

This package provides [PEP 561] `py.typed` stubs generated from FreeCAD's
C++ Python bindings, so static type checkers and IDEs can understand the
FreeCAD objects, modules, and functions available at runtime.

## Installation

### pip

```sh
pip install freecad-typings
```

### uv

```sh
uv add freecad-typings
```

## Modules

The stubs cover the public FreeCAD Python modules, including `FreeCAD`,
`FreeCADGui`, `Part`, and the other core workbench modules.

## Usage

Once installed, type checkers (e.g. `pyright`, `pyre`, `mypy`) and editors 
will automatically pick up the stubs for the FreeCAD modules.

These stubs are generated and intended for static analysis; they are not a
runtime replacement for the real FreeCAD binary.

[FreeCAD]: https://www.freecad.org/
[PEP 561]: https://peps.python.org/pep-0561/
