Metadata-Version: 2.4
Name: uEdition
Version: 2.0.2
Project-URL: Documentation, https://github.com/uEdition/uEdition#readme
Project-URL: Issues, https://github.com/uEdition/uEdition/issues
Project-URL: Source, https://github.com/uEdition/uEdition
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.10
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.10
Requires-Dist: httpx<0.29,>=0.28.1
Requires-Dist: livereload
Requires-Dist: lxml<6.0.0,>=4.9.2
Requires-Dist: myst-parser<5,>=4.0.1
Requires-Dist: packaging==24.2
Requires-Dist: pydantic-settings<3.0.0,>=2.0.0
Requires-Dist: pydantic<3.0.0,>=2.0.0
Requires-Dist: pyyaml<7.0.0,>=6.0.0
Requires-Dist: sphinx-book-theme<2,>=1.1.4
Requires-Dist: sphinx-design
Requires-Dist: sphinx-external-toc<2,>=1.0.1
Requires-Dist: sphinx<9,>=8.2.3
Requires-Dist: strictyaml<2,>=1.7.3
Requires-Dist: tomlkit<0.14,>=0.13.2
Requires-Dist: typer<1.0.0
Description-Content-Type: text/markdown

# μEdition

The μEdition is a micro framwork for quickly building Editions.

[![PyPI - Version](https://img.shields.io/pypi/v/uedition.svg)](https://pypi.org/project/uedition)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/uedition.svg)](https://pypi.org/project/uedition)
[![Test workflow status](https://github.com/uEdition/uEdition/actions/workflows/tests.yml/badge.svg)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
[![Test coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/scmmmh/13b76c3c8e59fa624d03918fafde3f2d/raw/coverage.json)](https://github.com/uEdition/uEdition/actions/workflows/tests.yml)
[![Documentation Status](https://readthedocs.org/projects/uedition/badge/?version=latest)](https://uedition.readthedocs.io/en/latest/?badge=latest)

-----

**Table of Contents**

- [Quickstart](#quickstart)
- [Documentation](#documentation)
- [License](#license)

## Quickstart

To quickly get started with the μEdition follow these steps:

1. Install [Hatch](https://hatch.pypa.io/latest/install/) for your operating system.
2. Create a new folder for your μEdition.
3. Download the default {download}`https://uedition.readthedocs.io/latest/en_static/pyproject.toml` and move that into
   your new folder.
4. Open a new terminal, change into your new folder and run the following command:

   :::{code-block} console
   hatch run init
   :::

   This creates the configuration file ({file}`uEdition.yml`) and table of contents ({file}`toc.yml`).

5. Then run the following command to add content in a new language:

   :::{code-block} console
   hatch run language add
   :::

   This will ask you a few questions about the new language and then create the required files.

5. Then run the following command to start the writing server:

   :::{code-block} console
   hatch run serve
   :::

## Documentation

Full documentation is available at [https://uedition.readthedocs.io](https://uedition.readthedocs.io).

## License

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