Metadata-Version: 2.3
Name: ocelescope-backend
Version: 0.1.1
Summary: Ocelescope backend host application
Requires-Dist: pm4py~=2.7.22
Requires-Dist: pandas>=2.3.1
Requires-Dist: numpy>=2.3.2
Requires-Dist: cachetools>=6.1.0
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pydantic-settings>=2.2.1,<3
Requires-Dist: fastapi[standard]>=0.136.0
Requires-Dist: uvicorn>=0.49,<0.50
Requires-Dist: ocelescope[plugin]>=0.3.0,<0.4.0
Requires-Dist: orjson>=3.11.3
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# ocelescope-backend

The Ocelescope backend host application. It exposes the FastAPI server that
serves OCELs, resources and modules, and provides the `ocelescope-backend`
command-line interface.

## Installation

```bash
pip install ocelescope-backend
```

## Usage

Start the development server:

```bash
ocelescope-backend serve
```

Other commands (e.g. generating an OpenAPI schema for a module) are available
via:

```bash
ocelescope-backend --help
```

## Modules

The backend discovers modules through the `ocelescope_backend.modules` entry
point group. Installing a module package (for example
[`ocelescope-module-ocelot`](../modules/ocelescope-module-ocelot)) makes it
available to the host automatically.

## About

Part of [Ocelescope](https://github.com/promi4s/ocelescope), a framework for
working with Object-Centric Event Logs developed at the Chair of Process and
Data Science (PADS), RWTH Aachen University.

📖 Documentation: <https://www.ocelescope.org>
