Metadata-Version: 2.4
Name: tipi-studio-api
Version: 0.1.2
Summary: Typing interface for the public Tipi Studio Python API
Project-URL: Repository, https://github.com/tomfmw/tipi_studio
Project-URL: Documentation, https://github.com/tomfmw/tipi_studio
Author: Tipi Studio
License: Proprietary
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Typing :: Stubs Only
Requires-Python: ==3.12.*
Description-Content-Type: text/markdown

# Tipi Studio API

`tipi-studio-api` provides editor completion and static type checking for the
public Tipi Studio Python API. It contains type stubs only: it does not include
the Tipi Studio runtime or expose project source code.

Install it in the Python environment used by your editor:

```bash
python -m pip install tipi-studio-api
```

Exported Tipi Studio scripts continue to use the normal import:

```python
import tipi_studio as tipi
```

Run those scripts through Tipi Studio's supported runtime, for example
`tipi run exported_project.py`. The runtime is not installed by this package.

The supported typing surface is the API emitted by Tipi Studio's Python project
export: project creation and writing, catalogues, geometry, coordinate-system,
control-point-group, configuration, interpolator, grading, and parameter
definition factories.
