# machine68k - m68k Emulator and Machine Binding for Python
- written by Christian Vogelgsang <chris@vogelgsang.org>
- under the GNU Public License V2
## Introduction
`machine68k` is a Python package that offers a system binding for
the [Musashi][1] Motorola 68000 CPU emulator with memory binding and
support for ALine opcode exception traps.
The package is currently used by the [amitools][2] project and
supplies the CPU emulation for `vamos`.
## Prerequisites
- Python >= ```3.8```
- [pip3][3]
## Optional Packages
- [cython][4]: (version >= **3.0.0**) required to rebuild the native module
[1]: https://github.com/kstenerud/Musashi
[2]: https://github.com/cnvogelg/amitools
[3]: https://packaging.python.org/en/latest/tutorials/installing-packages/
[4]: https://cython.org
## Installation
### Stable/Release Version
```bash
pip3 install machine68k
```
Note:
- on Linux/macOS may use ``sudo`` to install for all users
- requires a host C compiler to compile the extension.
- the version may be a bit outdated. If you need recent changes use the
current version.
### Current Version from GitHub
Ensure you have Cython installed:
```bash
pip3 install cython
```
Then install `machine68k` directly from the git repository:
```bash
pip3 install -U git+https://github.com/cnvogelg/machine68k.git
```
Or if you have a local clone of the repository:
```bash
pip3 install .
```
Note:
- This will install the latest version found in the github repository.
- You find the latest features but it may also be unstable from time to time.
- Repeat this command to update to the latest version.
### Developers
- Follow this route if you want to hack around with the codebase
- Clone the Git repo: [machine68k@git](https://github.com/cnvogelg/machine68k)
- Ensure you have Cython installed:
```bash
pip3 install cython
```
- Enter the directory of the cloned repo and install via pip:
```bash
pip3 install -U -e .
```
This install `machine68k` in your current Python environment but takes the
source files still from this repository. So you can change the code there
and directly test the machine.
Raw data
{
"_id": null,
"home_page": null,
"name": "machine68k",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "m68k, musashi, machine68k, system emulator",
"author": null,
"author_email": "Christian Vogelgsang <chris@vogelgsang.org>",
"download_url": "https://files.pythonhosted.org/packages/53/30/8548ba3cfd52f4cbef12c053532936a97f59d7044ed9ae0bc5eceb63e35d/machine68k-0.3.0.tar.gz",
"platform": null,
"description": "# machine68k - m68k Emulator and Machine Binding for Python\n\n- written by Christian Vogelgsang <chris@vogelgsang.org>\n- under the GNU Public License V2\n\n## Introduction\n\n`machine68k` is a Python package that offers a system binding for\nthe [Musashi][1] Motorola 68000 CPU emulator with memory binding and\nsupport for ALine opcode exception traps.\n\nThe package is currently used by the [amitools][2] project and\nsupplies the CPU emulation for `vamos`.\n\n## Prerequisites\n\n- Python >= ```3.8```\n- [pip3][3]\n\n## Optional Packages\n\n- [cython][4]: (version >= **3.0.0**) required to rebuild the native module\n\n[1]: https://github.com/kstenerud/Musashi\n[2]: https://github.com/cnvogelg/amitools\n[3]: https://packaging.python.org/en/latest/tutorials/installing-packages/\n[4]: https://cython.org\n\n## Installation\n\n### Stable/Release Version\n\n```bash\npip3 install machine68k\n```\n\nNote:\n\n- on Linux/macOS may use ``sudo`` to install for all users\n- requires a host C compiler to compile the extension.\n- the version may be a bit outdated. If you need recent changes use the\n current version.\n\n### Current Version from GitHub\n\nEnsure you have Cython installed:\n\n```bash\npip3 install cython\n```\n\nThen install `machine68k` directly from the git repository:\n\n```bash\npip3 install -U git+https://github.com/cnvogelg/machine68k.git\n```\n\nOr if you have a local clone of the repository:\n\n```bash\npip3 install .\n```\n\nNote:\n\n- This will install the latest version found in the github repository.\n- You find the latest features but it may also be unstable from time to time.\n- Repeat this command to update to the latest version.\n\n### Developers\n\n- Follow this route if you want to hack around with the codebase\n- Clone the Git repo: [machine68k@git](https://github.com/cnvogelg/machine68k)\n- Ensure you have Cython installed:\n\n```bash\npip3 install cython\n```\n\n- Enter the directory of the cloned repo and install via pip:\n\n```bash\npip3 install -U -e .\n```\n\nThis install `machine68k` in your current Python environment but takes the\nsource files still from this repository. So you can change the code there\nand directly test the machine.\n",
"bugtrack_url": null,
"license": "GPL-v2",
"summary": "A Cython binding for a m68k system emulator",
"version": "0.3.0",
"project_urls": null,
"split_keywords": [
"m68k",
" musashi",
" machine68k",
" system emulator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53308548ba3cfd52f4cbef12c053532936a97f59d7044ed9ae0bc5eceb63e35d",
"md5": "06ab698525245a9a6b9499fd76a514f4",
"sha256": "40bf621b208ae402317c3bd0abb7b6ae36124a2fc416d33599f35ee337028deb"
},
"downloads": -1,
"filename": "machine68k-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "06ab698525245a9a6b9499fd76a514f4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 398247,
"upload_time": "2024-08-25T17:45:44",
"upload_time_iso_8601": "2024-08-25T17:45:44.930659Z",
"url": "https://files.pythonhosted.org/packages/53/30/8548ba3cfd52f4cbef12c053532936a97f59d7044ed9ae0bc5eceb63e35d/machine68k-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-25 17:45:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "machine68k"
}
JSON