lug 0.1.2

Run Python functions in Docker containers, locally or in the cloud.

Lug

Lug is an open-source package that lets you run Python functions in any Docker container.

Lug runs the packaged function and Docker containers on your own computer or in the cloud.

Highlights

• 📦 subprocess.run, subprocess.Popen, and os.system run in your container – for the dependencies you can't install with pip.
• 🐍 Use containers as-is, no need to add your Python version
• ☁️ Run on your computer or in the cloud

What does Lug do?

Lug redirects calls to subprocess.run, subprocess.Popen, and os.system to any Docker container. This makes these system-level calls behave the same way on different machines.

Lug also packages the Python function and Docker container, so you can run it on the cloud if needed. This lets you give more computing power to the functions that need it.

Prerequisites

• macOS or Linux (supporting POSIX_SPAWN)
• Docker Engine and the Docker CLI

Install

Install Docker Engine and the CLI, if you don't have it.

With pip:

pip install lug

With Poetry:

poetry add lug

Get started

Run a Python function locally in a Docker image

Everything but the subprocess.run below runs as-is, with the echo command running in the Docker image:

import lug
import subprocess

@lug.run(image="alpine:3.16.2")
def hello_world():
    result = subprocess.run('echo "Hello, `uname`!"', capture_output=True, text=True, shell=True)
    return result.stdout

print(hello_world())

That's it! After it finishes, you'll see Hello, Linux!.

Docs

Full docs are at lug.dev

Open-source roadmap

• Run a Python function in a local container
• Maintain Python major.version in function and in container
• Serialize and deserialize Python function and Python dependencies
• os.system(), subprocess.run(), and subprocess.Popen() redirect to a user-specified container
• Local files passed to as input go to ./input/ in remote Docker container
• Remote files written to ./output/ in the container are written to local output Path
• Runs locally
• Run in the cloud with Toolchest
• Stream live stdout during remote execution
• Run in the cloud with AWS (help needed)
• Run in the cloud with GCP (help needed)

License

Lug is licensed under the Apache License 2.0