Metadata-Version: 2.1
Name: mdutilities
Version: 0.1.0
Summary: A command line tool for megadrive homebrew developers
Author-email: Pablo Porta <paspallasdev@gmail.com>
Maintainer-email: Pablo Porta <paspallasdev@gmail.com>
License: MIT License
        
        Copyright (c) 2024 Pablo Porta "Paspallas"
        
        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.
        
Project-URL: Issues, https://github.com/paspallas/mdutil/issues
Project-URL: Homepage, https://github.com/paspallas/mdutil
Project-URL: Documentation, https://mdutil.readthedocs.io
Keywords: homebrew,cli,megadrive,tiled,tool
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click>=8.1.7
Requires-Dist: numpy>=2.1.2
Requires-Dist: pillow>=11.0.0
Requires-Dist: zstandard>=0.23.0

# mdutil

`mdutil` is a Python cli application designed to help with common tasks in the context of game development for retro systems. It's specially tailored but not limited to the Sega Megadrive used in conjuntion
with [SGDK](https://github.com/Stephane-D/SGDK).

## Requirements

- Python 3.8+
- pipx

## Installation

Make sure to install the requirements. A complete guide on how to install `pipx` can be found at [link](https://pipx.pypa.io/stable/installation).

After that, open a terminal and run the following command:

```bash
pipx install mdutilities
```

This will install `mdutil` in a virtual environment managed by `pipx`. You can now start using it from the command line. Check the currently installed version by running:

```bash
mdutil version
```

When a new version becomes available you can upgrade your local installation by running:

```bash
pipx upgrade mdutilities
```

To completely uninstall `mdutil` run:

```bash
pipx uninstall mdutilities
```

## Usage

The full user guide can be found at [read the docs](https://mdutil.readthedocs.io).

## License

This project is licensed under the MIT License. See the LICENSE file for details.

## Contributing

Contributions are welcome! please open an issue or submit a pull request for any improvements or
bug fixes.

## Contact

For any questions or suggestions, please open an issue on GitHub.
