Metadata-Version: 2.4
Name: sputility
Version: 0.0.5
Summary: Python ME Utility
Author-email: aawilliams85 <adair.williams85@gmail.com>
License: MIT License
        
        Copyright (c) 2025 aawilliams85
        
        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: Repository, https://github.com/aawilliams85/sputility.git
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# sputility

sputility is a Python tool to interface with System Platform packages (*.aapkg).<br>
It's all preliminary guesswork and likely to change.  Use at your own risk.<br>

## Capabilities

The public classes in sputility provide the following capabilities:

> ### SPUtility
>
> SPUtility provides the following standard functions:
> - Decompress package (extract files from *.aaPKG to disk)
> - Deserialize package (extract files from *.aaPKG to memory, deserialize individual object *.txt files to disk)
> - Deserialize object (deserialize specific object *.txt file to disk)

## Getting Started

### Installation

To install from pip, run the following command:
```console
pip install sputility
```

To upgrade to the latest release:
```console
pip install sputility --upgrade
```

### Example

```python
from sputility import SPUtility
spu = SPUtility()
spu.deserialize_package(
    input_path='YourAaPkgFile', 
    output_path='YourFolder', 
    progress=None
)
```

## Contributing

Contributions welcome!<br>
Ideas, code, hardware testing, bug reports, etc.<br>
