Home

PyPositron Documentation

Welcome to the PyPositron documentation! This guide will help you get started with building cross-platform desktop applications using HTML, CSS, and Python.

Table of Contents

• Getting Started
• Installation
• CLI Reference
• API Reference
• Project Structure
• Examples
• Troubleshooting

What is PyPositron?

PyPositron is a Python framework that allows you to build cross-platform desktop applications using web technologies (HTML, CSS) with Python as the backend and frontend. Think of it as Electron for Python developers.

Key Features

• 🚀 Easy to use: Simple CLI commands to create and manage projects
• 🎨 Web-based UI: Build your interface using HTML and CSS
• 🐍 Python backend: Use Python for all your application logic
• 📦 Virtual environment support: Isolated project environments
• 🔧 Cross-platform: Works on Windows, macOS, and Linux
• ⚡ Lightweight: Efficient installer creation using existing browsers

Quick Example

import py_positron as main

# Open a window with your HTML file
main.openUI("views/index.html", None, 900, 700, "My App")

# Start the application
main.start()

Support

• 📚 Documentation
• 🐛 Issues
• 💬 Discussions

License

PyPositron is licensed under the AGPL-3.0-or-later license.