pylon-app 0.5.1

No project description provided

Pylon 💎

Pylon is a framework that allows you to easily create desktop applications using Python and web technologies. 🐍🌐

Key Features 🚀

• Web-based GUI generation
• System tray icon support 🖥️
• Multi-window management 🪟
• Bridge API between Python and JavaScript 🌉
• Single instance application support
• Cross-platform support for Windows, macOS, and Linux 🌍

Installation 📦

Direct Installation

pip install pylon-app

Package URL: https://pypi.org/project/pylon-app/

Creating a React + Pylon Project

Boilerplate address: https://github.com/python-pylon/pylon-react-boilerplate

Usage 🛠️

Creating a Basic Application

from pylon import PylonApp

app = PylonApp(single_instance=True, icon_path="assets/icon.ico")

window = app.create_window(
    "https://www.example.com",
    title="Pylon Browser",
)

app.run()

Setting Up System Tray

from pylon import TrayEvent

def on_double_click():
    print("Tray icon was double-clicked.")

app.set_tray_actions({
    TrayEvent.DoubleClick: on_double_click,
})
app.set_tray_menu_items([
    {"label": "Show Window", "callback": app.show_main_window},
    {"label": "Quit", "callback": app.quit},
])
app.setup_tray()

Creating Python-JavaScript Bridge API

from pylon import PylonAPI, Bridge

class CustomAPI(PylonAPI):
    @Bridge(str, int, result=str)
    def echo(self, message, number):
        return f"Message received in Python: {message}, {number}"

    @Bridge(result=str)
    def getAppVersion(self):
        return "1.0.0"

    @Bridge(result=str)
    def create_window(self):
        window = app.create_window(
            "alert.html",
            js_apis=[CustomAPI()],
            width=300,
            height=200,
            x=100,
            y=100,
        )
        return window.id

window = app.create_window(
    "index.html",
    js_apis=[CustomAPI()],
    # Other options...
)

// CustomAPI method usage example
document.addEventListener('pylonReady', function () {
  // Using the echo method
  pylon.CustomAPI.echo('Hello', 42).then((result) => {
    console.log(result); // "Message received in Python: Hello, 42" output
  });

  // Using the getAppVersion method
  pylon.CustomAPI.getAppVersion().then((version) => {
    console.log('App version:', version); // "App version: 1.0.0" output
  });

  // Example using async/await syntax
  async function useCustomAPI() {
    const echoResult = await pylon.CustomAPI.echo('Test', 100);
    console.log(echoResult);

    const appVersion = await pylon.CustomAPI.getAppVersion();
    console.log('Current app version:', appVersion);
  }

  useCustomAPI();

  // Button click event binding
  document.getElementById('myButton').addEventListener('click', function () {
    // Using the create_window method
    pylon.CustomAPI.create_window().then((windowId) => {
      console.log('New window ID:', windowId); // "New window ID: [generated window ID]" output
    });
  });
});

Using React

import { StrictMode } from 'react';
import { createRoot } from 'react-dom/client';
import App from './App.jsx';
import './index.css';

document.addEventListener('pylonReady', function () {
  createRoot(document.getElementById('root')).render(
    <StrictMode>
      <App />
    </StrictMode>
  );
});

function App() {
  console.log('Pylon is ready');

  window.pylon.CustomAPI.getAppVersion().then((version) => {
    console.log('App version:', version); // "App version: 1.0.0"
  });
  return <h1>Hello World</h1>;
}

API Reference 📚

PylonApp

• create_window(url, title, frame, context_menu, js_apis, enable_dev_tools, width, height, x, y) -> BrowserWindow: Creates a new window and returns a BrowserWindow object.
• run(): Runs the application.
• set_tray_actions(actions): Sets tray icon actions.
• set_tray_menu_items(items): Sets tray menu items.
• setup_tray(): Sets up the system tray.
• get_windows(): Returns a list of all browser windows.
• show_main_window(): Shows and focuses the first window.
• get_window_by_id(window_id): Returns the window with the given ID.
• hide_window_by_id(window_id): Hides the window with the given ID.
• show_window_by_id(window_id): Shows the window with the given ID.
• close_window_by_id(window_id): Closes the window with the given ID.
• close_all_windows(): Closes all windows.
• quit(): Quits the application.
• toggle_fullscreen_by_id(window_id): Toggles fullscreen mode for the window with the given ID.
• minimize_window_by_id(window_id): Minimizes the window with the given ID.
• maximize_window_by_id(window_id): Maximizes the window with the given ID.
• restore_window_by_id(window_id): Restores the window with the given ID to its normal state.'

BrowserWindow

• __init__(app, title, url, frame, context_menu, js_apis, enable_dev_tools, width, height, x, y): Initializes a new browser window.
• open_dev_window(): Opens the developer tools window.
  • When enable_dev_tools=True, pressing F12 will open the dev tools window.
• get_window_properties(): Returns the properties of the window.
• hide_window(): Hides the window.
• show_window(): Shows and focuses the window.
• close_window(): Closes the window.
• toggle_fullscreen(): Toggles fullscreen mode for the window.
• minimize_window(): Minimizes the window.
• maximize_window(): Maximizes the window.
• restore_window(): Restores the window to its normal state.
• set_url(url): Sets the URL of the window.

PylonAPI

Used to define bridge APIs for communication between Python and JavaScript.

• @Bridge(*arg_types, result=return_type): Converts a Python method into a function callable from JavaScript.
  • arg_types: Types of function arguments (multiple possible)
  • result: Type of return value (optional)

Basic Bridge window.WindowAPI Functions

getWindowId

• window.WindowAPI.getWindowId() -> str: Returns the current window ID.

closeWindow

• window.WindowAPI.closeWindow(): Closes the window with the given window ID.

hideWindow

• window.WindowAPI.hideWindow(): Hides the window with the given window ID.

showWindow

• window.WindowAPI.showWindow(): Shows and focuses the window with the given window ID.

toggleFullscreen

• window.WindowAPI.toggleFullscreen(): Toggles fullscreen mode for the window with the given window ID.

minimizeWindow

• window.WindowAPI.minimizeWindow(): Minimizes the window with the given window ID.

maximizeWindow

• window.WindowAPI.maximizeWindow(): Maximizes the window with the given window ID.

restoreWindow

• window.WindowAPI.restoreWindow(): Restores the window with the given window ID to its normal state.

setUrl

• window.WindowAPI.setUrl(url): Sets the URL of the window.

License 📄

This project is licensed under the terms of the Apache License 2.0. See the LICENSE file for details.

This project uses PySide6, which is licensed under the LGPL (Lesser General Public License).

Contributing 🤝

(Add information about how to contribute here)