Metadata-Version: 2.4
Name: viur-scriptor-api
Version: 1.11.0
Summary: This is the internal Scriptor library that the viur-scriptor utilizes. The API includes components for networking as well as parts related to the Scriptor's files.
Project-URL: Documentation, https://viur-scriptor-api.readthedocs.io
Project-URL: Repository, https://github.com/viur-framework/viur-scriptor-api
Project-URL: Bug Tracker, https://github.com/viur-framework/viur-scriptor-api/issues
Author-email: Mausbrand Informationssysteme GmbH <devs@viur.dev>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Interpreters
Requires-Python: >=3.10
Requires-Dist: chardet==5.2.0
Requires-Dist: openpyxl==3.1.5
Requires-Dist: prompt-toolkit==3.0.47
Requires-Dist: python-magic==0.4.27
Requires-Dist: requests==2.31.0
Requires-Dist: simple-term-menu==1.6.4
Description-Content-Type: text/markdown

<div align="center">
    <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-scriptor.svg" height="196" alt="A hexagonal logo of Scriptor" title="Scriptor logo">
    <h1>viur-scriptor-api</h1>
    <a href="https://pypi.org/project/viur-scriptor-api/">
        <img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-scriptor-api">
    </a>
    <a href="https://viur-scriptor-api.readthedocs.io/en/latest/?badge=latest">
        <img src="https://readthedocs.org/projects/viur-scriptor-api/badge/?version=latest" alt="Documentation Status">
    </a>
    <a href="LICENSE">
        <img src="https://img.shields.io/github/license/viur-framework/viur-scriptor-api" alt="Badge displaying the license" title="License badge">
    </a>
    <br>
    Universal Python API for scripting and interacting with ViUR.
</div>

## About

This is the official Scriptor API, which is used by the viur-scriptor in both the web version and the terminal version.

## Usage

Implements the `viur.scriptor`-namespace.

You can use it either in the Pyodide-based scriptor as well as in native Python using `from viur.scriptor import ...`.

## Documentation

- [viur-scriptor-api.readthedocs.io](https://viur-scriptor-api.readthedocs.io/en/latest/)

## License

Copyright © 2025 by Mausbrand Informationssysteme GmbH.<br>
Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.

viur-scriptor-api is free software under the MIT license.<br>
Please see the LICENSE file for details.
