Metadata-Version: 2.1
Name: pymemuc
Version: 0.0.6
Summary: A Memuc.exe wrapper for Python
Home-page: https://github.com/marmig0404/pymemuc
License: MIT
Keywords: memu,memuc,wrapper,api
Author: Martin Miglio
Author-email: code@martinmiglio.dev
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
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
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Project-URL: Documentation, https://github.com/marmig0404/pymemuc/blob/master/docs/pymemuc.md
Project-URL: Repository, https://github.com/marmig0404/pymemuc
Description-Content-Type: text/markdown

# pymemuc

[![GitHub](https://img.shields.io/github/license/marmig0404/pymemuc)](LICENSE) [![CodeFactor](https://www.codefactor.io/repository/github/marmig0404/pymemuc/badge)][codefactor_link] [![PyPI](https://img.shields.io/pypi/v/pymemuc) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pymemuc)][pypi_link] [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pymemuc)][python_link]

A wrapper for [MEmu Command (MEMUC)][memuc_docs] in python.

Allows for easy interaction with MEmu VMs, including management, configuration, direct control and ADB interaction.

## Installation

```bash
pip install pymemuc
```

## Example usage

```python
# import the PyMemuc class
from pymemuc import PyMemuc

# create a PyMemuc instance, doing so will automatically link to the MEMUC executable
memuc = PyMemuc()

# create a new vm
memuc.create_vm()

# list out all vms, get the index of the first one
index = memuc.list_vm_info()[0][0]

# start the vm
memuc.start_vm(index)

# stop the vm
memuc.stop_vm(index)
```

See [the demo notebook][demo_notebook] for more examples.

## Documentation

See [pymemuc.md][full_doc] for full package documentation.

[python_link]: https://www.python.org/
[pypi_link]: https://pypi.org/project/pymemuc/
[codefactor_link]: https://www.codefactor.io/repository/github/marmig0404/pymemuc
[memuc_docs]: https://www.memuplay.com/blog/memucommand-reference-manual.html
[demo_notebook]: demo/demo.ipynb
[full_doc]: docs/pymemuc.md

