Added support for containerizing the server

Author: synacktraa

.dockerignore

@@ -0,0 +1,89 @@
+# Git
+.git
+.gitignore
+.gitattributes
+
+
+# CI
+.codeclimate.yml
+.travis.yml
+.taskcluster.yml
+
+# Docker
+docker-compose.yml
+Dockerfile
+.docker
+.dockerignore
+
+# Byte-compiled / optimized / DLL files
+**/__pycache__/
+**/*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Virtual environment
+.env
+.venv/
+venv/
+
+# PyCharm
+.idea
+
+# Python mode for VIM
+.ropeproject
+**/.ropeproject
+
+# Vim swap files
+**/*.swp
+
+# VS Code
+.vscode/

Dockerfile

@@ -0,0 +1,30 @@
+# Multi-stage build. Build published at: https://hub.docker.com/repository/docker/synacktra/cillow
+
+FROM python:3.12-slim-bookworm AS builder
+
+ENV PYTHONUNBUFFERED=1 PYTHONDONTWRITEBYTECODE=1
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /cillow
+
+COPY . .
+
+RUN uv pip install --system --no-cache .
+
+RUN rm -rf /root/.cache \
+    && find /usr/local -depth \
+    -type f -name '*.pyc' -delete \
+    -o -type d -name __pycache__ -delete
+
+
+FROM python:3.12-slim-bookworm
+
+ENV PYTHONUNBUFFERED=1 PYTHONDONTWRITEBYTECODE=1
+
+COPY --from=builder /usr/local/lib/python3.12/site-packages/ /usr/local/lib/python3.12/site-packages/
+COPY --from=builder /usr/local/bin/ /usr/local/bin/

README.md

@@ -1,6 +1,6 @@
-# cillow
-
-<p align="center">Code Interpreter Library</p>
+<p align="center">
+    <img src="https://i.imgur.com/mBdWuQP.gif" width="550px" alt="cillow logo gif">
+</p>
 
 ---
 

client.py

@@ -0,0 +1,20 @@
+import cillow
+
+client = cillow.Client.new(host="127.0.0.1", port=5556)
+
+print(client.current_environment)
+
+client.run_code("""
+from PIL import Image, ImageDraw
+
+img = Image.new('RGB', (400, 300), 'white')
+
+draw = ImageDraw.Draw(img)
+draw.rectangle([50, 50, 150, 150], fill='blue')
+draw.ellipse([200, 50, 300, 150], fill='red')
+draw.line([50, 200, 350, 200], fill='green', width=5)
+
+img.show()
+""")
+
+client.disconnect()

docs/quickstart/using_cillow.md

@@ -81,15 +81,15 @@ client = cillow.Client.new(
 )
 ```
 
-### Switching Environment
+### Switching Python Environment
 
 > Every new environment starts up in a new interpreter process and has its own namespace.
 
 ```python
 client.switch_interpreter("/path/to/python/venv")
 ```
 
-### Deleting Environment
+### Deleting Python Environment
 
 ```python
 client.delete_interpreter("/path/to/python/env")
@@ -105,6 +105,8 @@ By default, the `run_code()` method automatically installs the required packages
 client.install_requirements("package1", "package2")
 ```
 
+To disable automatic installation feature in `run_code` method, set `CILLOW_DISABLE_AUTO_INSTALL` environment variable to `1`.
+
 > If `uv` is installed, it will be used to install the requirements; otherwise, it will fallback to `pip`.
 
 ### Running Commands

docs/sandboxing_the_server.md

@@ -0,0 +1,64 @@
+This guide will show you how to securely host the Cillow server using Docker, leveraging the Cillow base image for isolated and consistent deployments.
+
+---
+
+### 1. **Prerequisites**
+- Docker installed on your system
+- A [`server.py`](https://github.com/synacktraa/cillow/blob/main/server.py) file to configure and run the Cillow server. This file sets up and starts the server, optionally with custom patches or configurations (see [Using Cillow guide](./quickstart/using_cillow.md)).
+
+---
+
+### 2. **Creating the Dockerfile**
+Create a `Dockerfile` in the same directory as your `server.py` file:
+
+```dockerfile
+FROM synacktra/cillow:latest
+
+# Uncomment the following line if you want cillow to use uv for package installation
+# COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+WORKDIR /app
+
+# Copy your server script into the container
+COPY server.py .
+
+# Expose the port the server will listen on
+EXPOSE 5556
+
+# Define the command to start the server
+CMD ["python", "server.py"]
+```
+
+---
+
+### 3. **Building the Docker Image**
+Run the following command to build the Docker image. The `-t` flag tags the image as `cillow-server`:
+
+```bash
+docker build -t cillow-server .
+```
+
+---
+
+### 4. **Running the Docker Container**
+Launch the container using the built image. The `--init` flag ensures proper process handling, and `-it` keeps the container interactive:
+
+```bash
+docker run --init -it -p 5556:5556 --name cillow-server cillow-server
+```
+
+This maps port `5556` from the container to your local machine, enabling client connections.
+
+---
+
+### 5. **Accessing the Sandboxed Server**
+Once the container is running, the Cillow server will be available at `localhost:5556`. Use `cillow.Client` to interact with the server as explained in the [Using Cillow guide](./quickstart/using_cillow.md#interacting-with-the-server).
+
+---
+
+### 6. **Customizing Your Server**
+Enhance your server with additional features by:
+- Adding custom patches
+- Configuring interpreter limits or other server parameters
+
+Simply modify your `server.py`, rebuild the Docker image, and restart the container with updated settings.

mkdocs.yml

@@ -14,7 +14,7 @@ nav:
           - Using Cillow: quickstart/using_cillow.md
           - Custom Patches: quickstart/custom_patches.md
           - Connecting LLMs & Frameworks: quickstart/connecting_LLM_&_Frameworks.md
-
+      - Sandboxing The Server: sandboxing_the_server.md
       - Supported Languages: supported_languages.md
 
   - Cookbooks: cookbooks.md

server.Dockerfile

@@ -0,0 +1,15 @@
+FROM synacktra/cillow:latest
+
+# Uncomment the following line if you want cillow to use uv for package installation
+# COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+
+WORKDIR /app
+
+# Copy your server script into the container
+COPY server.py .
+
+# Expose the port the server will listen on
+EXPOSE 5556
+
+# Define the command to start the server
+CMD ["python", "server.py"]

server.py

@@ -0,0 +1,11 @@
+import cillow
+
+cillow.add_patches(
+    cillow.prebuilt_patches.patch_stdout_stderr_write,
+    cillow.prebuilt_patches.patch_matplotlib_pyplot_show,
+    cillow.prebuilt_patches.patch_pillow_show,
+)
+
+if __name__ == "__main__":
+    server = cillow.Server(port=5556, max_interpreters=2, interpreters_per_client=1)
+    server.run()