Installation

You can install zytron with pip in a Python>=3.10 environment.

Prerequisites

Before you begin, ensure you have the following installed:

Installation Options

pip (Recommended)

Headless Installation

The headless installation of zytron is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.

pip install zytron

Using Docker COMING SOON [DOES NOT WORK YET]

Docker is an excellent option for creating isolated and reproducible environments, suitable for both development and production.

  1. Pull the Docker image:

    docker pull openagents_ai/zytron
  2. Run the Docker container:

    docker run -it --rm openagents_ai/zytron
  3. Build and run a custom Docker image:

    # Dockerfile
    FROM python:3.10-slim
    
    # Set up environment
    WORKDIR /app
    COPY . /app
    
    # Install dependencies
    RUN pip install --upgrade pip && \
        pip install -e .
    
    CMD ["python", "your_script.py"]
    # Build and run the Docker image
    docker build -t zytron-custom .
    docker run -it --rm zytron-custom

Using Kubernetes

Kubernetes provides an automated way to deploy, scale, and manage containerized applications.

  1. Create a Deployment YAML file:

    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: zytron-deployment
    spec:
      replicas: 3
      selector:
        matchLabels:
          app: zytron
      template:
        metadata:
          labels:
            app: zytron
        spec:
          containers:
          - name: zytron
            image: openagents_ai/zytron
            ports:
            - containerPort: 8080
  2. Apply the Deployment:

    kubectl apply -f deployment.yaml
  3. Expose the Deployment:

    kubectl expose deployment zytron-deployment --type=LoadBalancer --name=zytron-service

Javascript

Get started with the NPM implementation of Zytron:

npm install zytron-js

Last updated