Metadata-Version: 2.4
Name: uEdition-Editor
Version: 2.0.0b19
Project-URL: Documentation, https://github.com/uEdition/uEditor#readme
Project-URL: Issues, https://github.com/uEdition/uEditor/issues
Project-URL: Source, https://github.com/uEdition/uEditor
Author-email: Mark Hall <mark.hall@work.room3b.eu>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: aiocron<3,>=2.1
Requires-Dist: fastapi<1
Requires-Dist: httptools<1
Requires-Dist: httpx<1,>=0.28.1
Requires-Dist: lxml<7,>=5
Requires-Dist: pydantic-settings<3,>=2
Requires-Dist: pydantic[email]<3,>=2
Requires-Dist: pygit2<2,>=1.17.0
Requires-Dist: pyjwt[crypto]<3,>=2.10.1
Requires-Dist: python-multipart<1,>=0.0.9
Requires-Dist: python-slugify<9,>=8.0.4
Requires-Dist: pyyaml-include<3,>=2
Requires-Dist: pyyaml<7,>=6
Requires-Dist: typer<1,>=0.15.1
Requires-Dist: uedition<2.1,>=2.0.0a2
Requires-Dist: uvicorn<1
Requires-Dist: uvloop<1
Requires-Dist: websockets<16,>=15
Description-Content-Type: text/markdown

# μEditor

[![PyPI - Version](https://img.shields.io/pypi/v/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition-editor.svg)](https://pypi.org/project/uedition-editor)
[![Test workflow status](https://github.com/uEdition/uEditor/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)
[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/5e5b6cc511c2b9d625cba7bf9857a820/raw/coverage.json)](https://github.com/uEdition/uEditor/actions/workflows/tests.yml)

---

**Table of Contents**

- [Installation](#installation)
- [Documentation](#documentation)
- [License](#license)

## Installation

The simplest way to install the μEditor is using [pipx](https://github.com/pypa/pipx). Install pipx for your
operating system and then run the following command to install the μEditor:

```console
pipx install "uedition-editor>=2.0.0b2,<3"
```

Then run the following command to start the μEditor:

```console
UEDITOR__BASE_DIR=path/to/where/your/files/are ueditor server
```

The μEditor is then available at http://localhost:8000.

## Documentation

Documentation to come soon.

## License

`ueditor` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
