raypack

Raypack will create a package for AWS Glue, Ray.io tasks. This automates this documentation page that has some hand-wavy descriptions of shell commands. AWS Lambdas also call for a similar type of packaging, but as far as I know it is no sort of standard.

Problems this solves:

Putting pure python into a conforming zip
- With a wrapper folder
- Without dist-info or OS junk files
- Without the modules that AWS automatically includes
- Pinned to poetry lock files
- With own module code (exactly as specified in poetry section)
- With own dependencies (exactly as specified in poetry section)
- Warn you if you're doing something wrong
Optionally uploading to S3
Optionally upload entrypoint script(s) to s3- Not implemented yet!
Supports poetry based projects. More to be supported in the future.
Attempting to create a Linux Arm64 zip package when your build runner isn't Linux or Arm64 (Error prone!)

See below for build options.

raypack is not supported by Amazon, AWS, nor Anyscale, Inc the makers of ray.io. Some code generate with ChatGPT (OpenAI)

Installation

You are encouraged to install with pipx so that the CLI tools dependencies do not conflict with your project dependencies.

pipx install raypack

Usage

raypack [--verbose]

python -m raypack  [--verbose]

Configuration. If none specified, defaults are as below.

[tool.raypack]
exclude_packaging_cruft = true
outer_folder_name = "venv"
source_venv = ".venv"
venv_tool = "poetry"

Build Options

If your dependencies are all pure python, the packaging will work on any machine. However, if your dependencies have any native code:

Arm64 built on an Arm64 machine

An actual arm64 build runner with gcc - Best option, will allow compiling native code correctly.
Docker e.g. FROM public.ecr.aws/lambda/python:3.9-arm64 - Second best option, I haven't tried it, not sure if it works on all build runners that are not actually arm64 CPUs. example

Mac Binaries

An arm64 machine e.g. mac - Next best option, not sure if it will work.

Precompiled Binaries

Any machine or an arm64 machine like a mac- Would work in limited situations, namely when there are precompiled binaries (wheels) or all packages are pure python.

The last option works by telling pip to just download and unzip the arm64 wheels. If there aren't wheels or if the wheels weren't compiled for arm64, then you have to consider finding a different machine or convincing package maintainers to support wheels and more kinds of wheels.

How it works

On native arm64 machine

Gather info from pyproject.toml or CLI args, but not both.
Create a local .venv and .whl using poetry.
Create a new zip file with an extra top level folder.
Find the site-packages folder and copy to a new zip
Find the module contents in .whl and copy to a new zip
Upload to s3
Use s3 py modules "--s3-py-modules", "s3://s3bucket/pythonPackage.zip"

On non-arm64 machine

Use poetry lock file to generate requirements.txt
Use pip's download target with specified platform (arm64) to simulate creating a venv
Combine with own code as above
Upload to s3 as above

Local Development

When you write a glue script locally, you will reference

your own entry script (a .py file)
maybe your own module folder(s)
anything you pip install from public or private package repositories
the packages that AWS includes automatically, which are many pure and binary python repos from pypi, plus PyAmazonCACerts which is not on pypi.

See requirements_in_glue_...txt

Contributing

See above for how to develop, package and deploy your own glue code. To contribute to raypack, install and run tests and linting tools with poetry and make.

poetry install --with dev
make check

To see if the app can package up other apps

# builds, installs with pipx
make deploy

And then in a different project with a pyproject.toml file, run

raypack --verbose

Prior Art

Random scripts in comments

Some make file script

Similar to PEX or other venv zip tools, which as far as I know are not AWS aware, or they don't include all the dependencies, or they are more interested in making the archive file executable or self-extracting.

AWS Lambdas also have to go through a similar ad hoc zip process.

Documentation

TODO

Change Log

0.1.0 - Idea and reserve package name.

matthewdeanmartin / raypack