Jeff Epler
d325558b56
These are convenience targets for running specific tests as a developer. They are more useful that invoking run-tests directly as they take account of the VARIANT= specified on the make command-line. For instance, you can run all tests matching the regular expression "int" with `make VARIANT=... test//int`. (the new targets are all documented in README.md) Signed-off-by: Jeff Epler <jepler@gmail.com> |
||
|---|---|---|
| .forgejo/workflows | ||
| .github | ||
| docs | ||
| drivers | ||
| examples | ||
| extmod | ||
| lib | ||
| logo | ||
| mpy-cross | ||
| ports | ||
| py | ||
| shared | ||
| tests | ||
| tools | ||
| .git-blame-ignore-revs | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .pre-commit-config.yaml | ||
| .readthedocs.yaml | ||
| ACKNOWLEDGEMENTS | ||
| CODECONVENTIONS.md | ||
| CODEOFCONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| pyproject.toml | ||
| README.md | ||
m68k-micropython
This is a fork of the MicroPython project, which aims to put an implementation of Python 3.x on m68k Macintosh computers.
You can find the official micropython website at micropython.org.
WARNING: this project is in alpha stage and is subject to changes of the code-base, including "git rebasing", project-wide name changes and API changes.
MicroPython implements the entire Python 3.4 syntax (including exceptions,
with, yield from, etc., and additionally async/await keywords from
Python 3.5 and some select features from later versions). The following core
datatypes are provided: str(including basic Unicode support), bytes,
bytearray, tuple, list, dict, set, frozenset, array.array,
collections.namedtuple, classes and instances. Builtin modules include
os, sys, time, re, and struct, etc.
Mac specific functionality includes:
os.VfsMacfor interacting with filesystems- The modules documented under "Macintosh Specific libraries", including
qd, wrapper around QuickDraw.
MicroPython can execute scripts in textual source form (.py files) or from precompiled bytecode (.mpy files), in both cases either from an on-device filesystem or "frozen" into the MicroPython executable.
Getting started
Grab a release image and use it with your favorite mac emulator, including the website Infinite Mac.
See the project's online documentation for the API reference and information about using M68k-MicroPython and information about how it is implemented.
We use GitHub Discussions as our forum, and Mastodon (#m68kMicroPython) for chat. These are great places to ask questions and advice from the community or to discuss your MicroPython-based projects.
For bugs and feature requests, please raise an issue and follow the templates there.
Full-screen Editor
A full-screen editor is frozen in: import editor; editor.edit("code.py")
This editor does not use the mouse, instead it uses arrow keys or emacs-like ctrl+n/p, ctrl-f/b, ctrl-a/e for cursor motion.
Launching Programs
Double click a file of type "mupy" and it is run as a Python program. I've found it convenient to create a file "edit_code.py" that invokes the full-screen editor on "code.py", which gives a quick-ish turnaround for development as long as you're not loading the Micropython program from a real floppy.
Contributing
MicroPython is an open-source project and welcomes contributions. To be productive, please be sure to follow the Contributors' Guidelines and the Code Conventions. Note that MicroPython is licenced under the MIT license, and all contributions should follow this license.
About this repository
This repository contains the following components:
- py/ -- the core Python implementation, including compiler, runtime, and core library.
- mpy-cross/ -- the MicroPython cross-compiler which is used to turn scripts into precompiled bytecode.
- ports/m68kmac -- platform-specific code for the Macintosh port
- lib/ -- submodules for external dependencies.
- tests/ -- test framework and test scripts.
- docs/ -- user documentation in Sphinx reStructuredText format. This is used to generate the online documentation.
- extmod/ -- additional (non-core) modules implemented in C.
- tools/ -- various tools, including the pyboard.py module.
- examples/ -- a few example Python scripts.
"make" is used to build the components, or "gmake" on BSD-based systems.
You will also need Retro68,
bash, gcc, and Python 3.3+ available as the command python3.
yamllib must be installed via pip3.
The easiest way to get Retro68 is by using docker and invoking the make docker-build target.
A goal of this project is to keep differences from micropython to a minimum, and to
rebase onto it from time to time. However, at present there are a couple of
nasty hacks in py/.
Supported platforms & architectures
The main targets are 4MB Mac with System 6 or System 7.
The MicroPython cross-compiler, mpy-cross
Most ports including m68kmac require the MicroPython cross-compiler to be built first. This program, called mpy-cross, is used to pre-compile Python scripts to .mpy files which can then be included (frozen) into the firmware/executable for a port. To build mpy-cross use:
$ cd mpy-cross
$ make
External dependencies
The core MicroPython VM and runtime has no external dependencies, but a given port might depend on third-party drivers or vendor HALs. This repository includes several submodules linking to these external dependencies. Before compiling a given port, use
$ cd ports/name
$ make submodules
to ensure that all required submodules are initialised.
Development status
The project owner (@jepler) occasionally develops and maintains this project for fun. Pull requests are appreciated. There are many bugs. Noting them with issues may be helpful, but do not expect rapid response. Feature requests are not likely to be acted on. The project is seeking co-maintainer(s).