Metadata-Version: 2.1
Name: restoration
Version: 0.2.0
Summary: A parser for Age of Mythology .mythrec files
Author-email: Jeremy Keeler <jeremy@keeler.dev>
License: Copyright (c) 2025 jeremy@keeler.dev
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.0.0
Provides-Extra: dev
Requires-Dist: black>=24.10.0; extra == "dev"
Requires-Dist: isort>=5.13.2; extra == "dev"
Requires-Dist: mypy>=1.14.1; extra == "dev"
Requires-Dist: pre-commit>=4.0.1; extra == "dev"
Requires-Dist: pytest>=8.3.4; extra == "dev"

# Restoration

# **UNDER ACTIVE DEVELOPMENT** - This project is currently under active development and is not yet ready for use.

[![PyPI version](https://badge.fury.io/py/restoration.svg)](https://badge.fury.io/py/restoration)

Restore [Age of Mythology](https://www.ageofempires.com/games/aom/age-of-mythology-retold/) rec files into a human readable format (and other utilities).

## Development setup

Clone the respository, create a new virtual environment, install the package and its dependencies:

```bash
# Install the package and its dev dependencies
pip install -e .[dev]

# Setup pre-commit hooks
pre-commit install
```

## Publishing

```bash
# Install the build and twine packages
pip install build twine

# Setup .pypirc file with correct tokens
# Run the publish script to publish to pypi
./bin/publish.sh
```
