Skip to main content

A small example package

Project description

PyPositron

PyPositron is currently in alpha stage. It is not yet ready for production use, but you can try it out and contribute to its development. See more in Contributing.

PyPositron is a Python-powered desktop app framework that lets you build cross-platform apps using HTML, CSS, and Python—just like Electron, but with Python as the backend. Write your UI in HTML/CSS, add interactivity with Python, and run your app natively!

Features

  • Build desktop apps using HTML and CSS.
  • Use Python for backend and frontend logic. (with support for both Python and JS)
  • Use any HTML/CSS framework (like Bootstrap, Tailwind, etc.) for your UI.
  • Use any HTML builder UI for your app (like Bootstrap Studio, Pinegrow, etc)
  • Use JS for compatibility with existing HTML/CSS frameworks.
  • Use AI tools for generating your UI without needing proprietary system prompts- simply tell it to generate HTML/CSS/JS UI for your app.
  • Virtual environment support.
  • Efficient installer creation for easy distribution (that does not exist yet) (The installer automatically finds an existing browser instead of installing a new one for every app like Electron.JS).

Why PyPositron?

Compared to Electron and other Python frameworks (like PyQt)-

Feature PyPositron Electron PyQt
Language Python JavaScript, C, C++, etc Python
UI Frameworks Only frontend HTML/CSS/JS Any Web technologies Qt Widgets
Packaging Efficient installer or standalone executable (not yet implemented) Electron Builder PyInstaller etc
Performance Lightweight Heavyweight Lightweight
AI Compatibility Yes Yes* No*
Compatibility All frontend HTML/CSS/JS frameworks All frontend and backend HTML/CSS/JS frameworks and web technologies Limited to Qt

* maybe

Quick Start

1. Create a New Project

Install PyPositron if not already installed:

pip install py-positron 

Them create a new project using the CLI:

positron create
# Follow the prompts to set up your project

There should be directories in this structure-

your_app/
├── backend
│   └── main.py
├── frontend/
│   └── index.html
├── [win/linux]venv/ # If created
│   └──...
├── LICENSE #MIT by default
├── config.json
└── ...
  • backend/main.py: Entry point for your app.
  • frontend/index.html: Your app's UI (HTML/CSS/inline Python/JS).
  • winvenv/ or linuxvenv/:: (Optional) Virtual environment for dependencies.

2. Run Your App

positron start

This should open up a window with a checkmark and a button.

CLI Commands

Command Description
positron create Create a new PyPositron project (interactive setup).
positron start [--executable <python>] Run your PyPositron app (optionally specify Python interpreter).
positron install <package> Install a Python package into the project venv.
positron venv Create a virtual environment inside your project folder.

Documentation & Resources

License

GNU AGPL v3 License. See LICENSE for details.

Contributing

This project is in alpha stage. Contributions are welcome. Things to do-

  • Make documentation and README that is not AI-generated
  • Add more examples and tutorials
  • Make the installer/executable creation system
  • Test on Linux
  • Add support for MacOS
  • Add building and packaging features (like converting to executables/installers that can run on any system without Python installed)
  • Optimize performance.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_positron-0.0.2.1.tar.gz (52.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_positron-0.0.2.1-py3-none-any.whl (55.0 kB view details)

Uploaded Python 3

File details

Details for the file py_positron-0.0.2.1.tar.gz.

File metadata

  • Download URL: py_positron-0.0.2.1.tar.gz
  • Upload date:
  • Size: 52.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for py_positron-0.0.2.1.tar.gz
Algorithm Hash digest
SHA256 dd17c93e42c14e60862ca5d52fa89bd97ac3e132f49590ef24154ef031929adb
MD5 4e14a17f32c5477fe1b8eff753d525a0
BLAKE2b-256 84a613df03fbc95cc2b88432014460d9717e78a9334c2ca6f4d6d09fef0a32ed

See more details on using hashes here.

File details

Details for the file py_positron-0.0.2.1-py3-none-any.whl.

File metadata

  • Download URL: py_positron-0.0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 55.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for py_positron-0.0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d5f9d82c13794986cf31adc2f11492c68cb1e7b01b56d8574646713e208b45a5
MD5 e91aafce5b0e1faea977be93bf3b576f
BLAKE2b-256 6e7a04d7f923da2321767760f26fd36bd0f1ac7a6b4953db9606b48d32570bd6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page