Metadata-Version: 2.1
Name: mpy-cross
Version: 1.12
Summary: micropython mpy-cross distribution
Home-page: https://gitlab.com/alelec/mpy_cross
Author: Damien George
Author-email: contact@micropython.org
Maintainer: Andrew Leech
Maintainer-email: andrew@alelec.net
License: MIT
Platform: UNKNOWN

=========
mpy-cross
=========

mpy-cross is the micropython cross compiler utility, used to pre-compile python files into bytecode suitable for running on your target.

This project compiles mpy-cross for windows, linux and macos and distributes them in python wheels for easy installation on development pc's.


Version
-------

The release version of this package directly corresponds to the micropython release it's built against.

If a wrapper update is needed for a particular release version, it will be updloaded with a `.postN` version

Weekly releases build against master should be available at: https://gitlab.com/alelec/mpy_cross/pipelines
These will have version numbers that reflect the previous release and the current git hash built against.

Usage
-----
mpy-cross can be run in three different ways

* From python command line ::

    python -m mpy_cross <args>
    python -m mpy_cross --version

* From python code ::

    import mpy_cross

    mpy_cross.run(*args, **kwargs)

    import subprocess
    proc = mpy_cross.run('--version', stdout=subprocess.PIPE)

 where `*args` are arguments passed to mpy-cross, `**kwargs` are arguments to pass to `subprocess.Popen()` internally

* Standalone ::

    # Print out path to actual mpy-cross exe
    python -c "import mpy_cross; print(mpy_cross.mpy_cross)"
    > /home/andrew/.local/share/virtualenvs/mpy_cross-gSGkki0d/lib/python3.5/site-packages/mpy_cross/mpy-cross
    /home/corona/.local/share/virtualenvs/mpy_cross-gSGkki0d/lib/python3.5/site-packages/mpy_cross/mpy-cross --version


mpy-cross options
-----------------
 ::

    usage: mpy-cross [<opts>] [-X <implopt>] <input filename>
    Options:
    --version : show version information
    -o : output file for compiled bytecode (defaults to input with .mpy extension)
    -s : source filename to embed in the compiled bytecode (defaults to input file)
    -v : verbose (trace various operations); can be multiple
    -O[N] : apply bytecode optimizations of level N

    Target specific options:
    -msmall-int-bits=number : set the maximum bits used to encode a small-int
    -mno-unicode : don't support unicode in compiled strings
    -mcache-lookup-bc : cache map lookups in the bytecode
    -march=<arch> : set architecture for native emitter; x86, x64, armv6, armv7m, armv7em, armv7emsp, armv7emdp, xtensa, xtensawin

    Implementation specific options:
      emit={bytecode,native,viper} -- set the default code emitter
      heapsize=<n> -- set the heap size for the GC (default 2097152)