🐍 Creating Python Apps - Where Code Meets Magic!

Welcome to the Python side of Dataloop Applications! Here's where we'll turn your Python code into powerful, production-ready applications. Let's dive into the enchanted world of Python apps! ✨

🔮 The Magic Behind Python Apps

Python Applications in Dataloop harness the power of our FaaS (Function as a Service) platform. Think of it as having a magical workshop where your Python code can create wonders! Want to see magic in action? Check out our face detection app - it's like giving your platform superhero vision! 🦸‍♂️

For a deep dive into the mystical arts of modules, services, and all things FaaS, venture into our FaaS documentation.

🪄 Pre-launch Spells (Build Scripts)

Just like a wizard prepares their potions before casting a grand spell, your app might need some preparation before it launches. That's where pre-launch scripts come in!

📜 The Basic Spell (Global Build Script)

Add a build.sh to your app's root directory, and it will run its magic before your app starts. Here's a simple enchantment:

build.sh

# Install your magical dependencies
pip3 install my-package==1.0.0

🎯 Service-Specific Spells

Need a special preparation spell for a specific service? No problem! Just name your script {service.name}-build.sh, and it will cast its magic only for that service.

🧙‍♂️ Pre-launch Script Powers

Your pre-launch scripts can:

• 📦 Install additional Python packages
• 🔧 Configure environment settings
• 📁 Create necessary directories
• 🔑 Set up authentication
• 🛠️ Prepare resources

💫 Best Practices for Python Apps

📚 Code Organization

• Keep your modules clean and focused
• Use clear, descriptive function names
• Document your magic (code) well
• Follow Python best practices

🏗️ Project Structure

• Organize related functions in modules
• Keep configuration in separate files
• Use meaningful directory names
• Include requirements.txt for dependencies

🔍 Testing

• Write unit tests for your functions
• Test your app in a development environment
• Verify all dependencies are listed
• Check for potential conflicts

🚀 Quick Start Template

Here's a magical template to get you started:

main.py

import dtlpy as dl

# Define your enchanted function

class MyMagicalFunction(dl.BaseServiceRunner):
    def my_magical_function(self, item: dl.Item):
        """
        Your function's magical description
        """
        return f"✨ Magic happening in {item.name}! ✨"

dataloop.json

{
  "name": "my-magical-app",
  "version": "1.0.0",
  "description": "My first Dataloop function",
  "components": {
    "modules": [
      {
        "name": "my-magical-function",
        "entrypoint": "main.py",
        "className": "MyMagicalFunction",
        "functions": [
          {
            "name": "my_magical_function",
            "inputs": [
              {
                "name": "item",
                "type": "Item"
              }
            ]
          }
        ]
      }
    ],
    "services": [
      {
        "name": "my-magical-service",
        "moduleName": "my-magical-function",
        "runtime": {
          "podType": "regular-m",
          "concurrency": 10,
          "runnerImage": "python:3.10",
          "autoscaler": {
            "type": "rabbitmq",
            "minReplicas": 0,
            "maxReplicas": 2,
            "queueLength": 100
          }
        }
      }
    ]
  }
}

Publish and install your app:

import dtlpy as dl
project = dl.projects.get(project_name="my-magical-app")
dpk = project.dpks.publish()
project.apps.install(dpk=dpk)

🎮 Testing Your Creation

Before releasing your magical creation to the world:

1. 🧪 Test locally using the SDK
2. 🔄 Verify all dependencies install correctly
3. 🎯 Check all services deploy properly
4. ⚡ Test performance under load
5. 📝 Document any special requirements

🎓 Pro Tips

• 🔍 Use logging for better debugging
• 🛡️ Handle errors gracefully
• 🔄 Consider service scaling
• 💾 Manage state carefully
• 🔒 Follow security best practices

Ready to create some Python magic? Let's start coding! 🚀✨

Need more inspiration? Check out our example apps or join our community of wizards!