cosmofy bundles your python app into a single executable which runs on
Linux, macOS, and Windows. It uses Cosmopolitan libc.
macOS / Linux:
dest=~/.local/bin/cosmofy
curl -sSz $dest -o $dest -L https://github.com/metaist/cosmofy/releases/latest/download/cosmofy
chmod +x $destWindows: (PowerShell instructions coming soon)
# bundle a script with python
cosmofy myscript.py # produces `myscript.com`
./myscript.com # runs on macOS / Linux / Windows
# bundle a whole directory; change output path
cosmofy src/my-pkg --args '-m my-pkg --more-args' --output dist/my-pkg
./dist/my-pkg # starts bundled python with "-m my-pky --more-args"
# bundle self-updater (see below)
cosmofy src/my-pkg \
--release-url https://github.com/metaist/cosmofy/releases/latest/download/cosmofy
./my-pkg.com # run app as normal
./my-pkg.com --self-update # run cosmofy.updater to install any updatescosmofy: Cosmopolitan Python Bundler
USAGE
cosmofy
[--help] [--version] [--debug] [--dry-run] [--self-update]
[--python-url URL] [--cache PATH] [--clone]
[--output PATH] [--args STRING]
<add>... [--exclude GLOB]... [--remove GLOB]...
[--receipt PATH] [--receipt-url URL] [--release-url URL]
[--release-version STRING]
GENERAL
-h, --help Show this help message and exit.
--version Show program version and exit.
--debug Show debug messages.
-n, --dry-run Do not make any file system changes.
--self-update Update `cosmofy` to the latest version.
CACHE
--python-url URL
URL from which to download Cosmopolitan Python.
[default: https://cosmo.zip/pub/cosmos/bin/python]
[env: COSMOFY_PYTHON_URL=]
--cache PATH
Directory in which to cache Cosmopolitan Python downloads.
Use `false` or `0` to disable caching.
[default: ~/.cache/cosmofy]
[env: COSMOFY_CACHE_DIR=]
--clone
Obtain python by cloning `cosmofy` and removing itself instead of
downloading it from `--python-url`.
OUTPUT
-o PATH, --output PATH
Path to output file.
[default: `<main_module>.com`]
`<main_module>` is the first module with a `__main__.py` or file with an
`if __name__ == "__main__"` line.
FILES
--args STRING
Cosmopolitan Python arguments.
[default: `"-m <main_module>"`]
If NOT using the self-updater, all python options are supported:
https://docs.python.org/3/using/cmdline.html
If using the self-updater only a subset is supported:
https://github.com/metaist/cosmofy#supported-python-cli
--add GLOB, <add>
At least one glob-like patterns to add. Folders are recursively added.
Files ending in `.py` will be compiled.
-x GLOB, --exclude GLOB
One or more glob-like patterns to exclude from being added.
Common things to exclude are egg files and python cache:
$ cosmofy src -x "**/*.egg-info/*" -x "**/__pycache__/*"
--rm GLOB, --remove GLOB
One or more glob-like patters to remove from the output.
Common things to remove are `pip`, terminal info, and SSL certs:
$ cosmofy src/my_module --rm 'usr/*' --rm 'Lib/site-packages/pip/*'
SELF-UPDATER
Specifying any of the options below will add `cosmofy.updater`
to make the resulting bundle capable of updating itself. You
must supply at least `--receipt-url` or `--release-url`.
In addition to building the bundle, there will be a second output
which is a JSON file (called a receipt) that needs to be uploaded
together with the bundle.
If the bundle is run with `--self-update` anywhere in the arguments,
`cosmofy.updater` will run. It will compare it's internal build
date with the date at `--receipt-url` and will download any updates, if
they exist.
Otherwise, the bundle will run as normal by calling `--args`
NOTE: The updater will alter `--args` so that it gets called first.
It supports most Python Command Line interface options (like `-m`).
For a full list see: https://github.com/metaist/cosmofy#supported-python-cli
--receipt PATH
Set the path for the JSON receipt.
[default: `<output>.json`]
--receipt-url URL
URL to the published receipt.
[default: --release-url + .json]
[env: RECEIPT_URL=]
--release-url URL
URL to the file to download.
[default: --receipt-url without .json]
[env: RELEASE_URL=]
--release-version STRING
Release version.
[default: first version-like string in `$(${output} --version)`]
If you provide --receipt-url or --release-url, cosmofy will add a
self-updater to the output bundle.
-
If the bundle is run with
--self-updateanywhere in the arguments,cosmofy.updaterwill run. It will compare it's internal build date with the date at--receipt-urland will download any updates, if they exist. -
Otherwise, the bundle will run as normal by calling
--args. See below for minor limitations.
Usage: <bundle> --self-update [--help] [--version] [--debug]
Options:
--self-update Run this updater instead of <bundle>
-h, --help Show this message and exit.
--version Show updater version and exit.
--debug Show debug messages.
[env: RECEIPT_URL=]
Override the embedded URL for downloading update metadata.
[env: RELEASE_URL=]
Override the published URL for downloading the update.
Cosmopolitan Python apps have a special .args file which is read when it
starts up. The contents of this file are typically set by the --args option.
However, when using the self-updater, we need to check for
the --self-update option first.
If --self-update is NOT present, we want to process the rest of the
--args as usual. However, since Python has already started, we only support
the following Python Command Line Interface options:
-c <command>: run a command-m <module-name>: run a module (this is the most common)-: read a command fromstdin(rare, but we support it)<script>: run a script on the filesystem-V, --version: display the Python version (we also support-VV)-h, -?, --help: show relevant portions of the help message-i: enter python REPL after executing a script (-c,-m,-, or<script>)-q: don't display copyright and version messages in interactive mode
If no option is provided, the Python REPL will run.