pytron-kit 0.1.3

An Electron-like library for Python using pywebview

Pytron

This guide provides a step-by-step walkthrough for building desktop applications using the Pytron framework. Pytron combines the power of Python's backend capabilities with the rich user interface of modern web frameworks like React.

Prerequisites

• Python 3.7+
• Node.js & npm (for frontend development)

Step 1: Project Setup

1. Clone/Create Project: Start with the Pytron project structure.
2. Install Python Dependencies:

   pip install pytron-kit
   

Step 2: Frontend Setup (React + Vite)

We recommend using Vite for a fast and modern development experience.

1. Initialize App: Navigate to your examples or project folder and run:

   pytron init my_app
   cd my_app/frontend
   

2. Install Pytron Client: Install the bridge library to communicate with Python.

   npm install pytron-client
   

Step 3: Backend Setup (Python)

1. Define and Expose Logic: Create functions you want to call from JavaScript and expose them.

       def greet(name):
           return f"Hello, {name}! From Python."
           
       # Expose the function to the frontend
       window.expose(greet)
       
       app.run(debug=True)
   
   if __name__ == '__main__':
       main()
   

Step 4: Connecting Frontend & Backend

Now, use the exposed Python functions in your React components.

1. Import Client:

   import pytron from 'pytron-client'
   

2. Call Python Functions: Pytron functions are asynchronous.

   async function handleGreet() {
     try {
       const message = await pytron.greet("User");
       console.log(message); // "Hello, User! From Python."
     } catch (err) {
       console.error("Error calling backend:", err);
     }
   }
   

Step 5: Advanced UI (Frameless Window)

For a native app feel, use a frameless window and create a custom title bar.

1. Backend: Set frameless=True in create_window.
2. Frontend: Create a TitleBar component.

   function TitleBar() {
     return (
       <div className="titlebar">
         <div className="drag-region">My App</div>
         <button onClick={() => pytron.minimize()}>-</button>
         <button onClick={() => pytron.close()}>x</button>
       </div>
     )
   }
   

3. CSS:

   .titlebar {
     display: flex;
     justify-content: space-between;
     background: #333;
     color: white;
     padding: 5px;
     user-select: none;
   }
   .drag-region {
     flex: 1;
     /* This is handled by Pytron's easy_drag or custom implementation */
   }
   

Step 6: Running the App

Run Python Script: bash cd .. pytron run --dev

Step 7: Packaging (Optional)

To distribute your app as a standalone .exe:

pytron package

---

Happy Coding with Pytron!