Skip to main content

Create modern cross-platform apps in Python using HTML and CSS

Project description

Neutron allows developers to build native Python apps along with CSS and HTML for frontend design. Based on pywebview for it's native GUI window and JavaScript-Python communication.

You can get started contributing via CONTRIBUTING.md or you can message me on discord (IanTheThird#9732) if you want more insigths on the code and tips on what to contribute.

Installation


pip install neutron-web

Building your project

To build a Neutron project you first need pyinstaller, install pyinstaller throught pip: pip install pyinstaller. Then run the script below in your command prompt/terminal. You can also use other programs to build your project such as py2exe if you prefer.

Note: If you are on linux use ":" instead of ";"


pyinstaller YOUR_PYTHON_FILE.py --noconsole --onefile --add-data="YOUR_HTML_FILE.html;." --add-data="YOUR_CSS_FILE.css;."

You don't need to use --add-data if your project doesn't have a CSS or HTML file

Examples

Full example

For a fully set up example project see TEMPLATE. The project is build how it's intended, meaning it has a CSS and HTML file for the design and a Python file for the logic. (It is comparable to how websites using JavaScript are built).

Other examples

Althought not recommended for big projects, it's possible to create an app using only a Python file.

import Neutron



win = Neutron.Window("Example")



HeaderObject = Neutron.elements.Header(win, id="title", content="Hello")





def setName():

    HeaderObject.setAttribute("style", "color: red;")

    HeaderObject.innerHTML = "Hello world!"

    win.getElementById("submit").innerHTML = "clicked!"





Neutron.elements.Button(win, id="submit", content="Hi", onclick=Neutron.event(setName))



win.show()

Another example featuring in-python HTML:

import Neutron



win = Neutron.Window("Example")



def setName():

    name = win.getElementById("inputName").value

    win.getElementById("title").innerHTML = "Hello: " + name





win.display(f"""



<!DOCTYPE html>

<html>

   <head lang="en">

      <meta charset="UTF-8">

   </head>

   <body>

      <h1 id="title">Hello: </h1>

      <input id="inputName">

      <button id="submitName" onclick="setName()">Submit</button>

   </body>

</html>

""", pyfunctions=[setName]) # Link up any Python functions so that they can be used inside the HTML

win.show()

Loader

To resolve slow loading times for bigger projects, Neutron features a loader system seen here:

import Neutron



win = Neutron.Window("Example", size=(600,100))



# The loader covers while all the other elements and css loads

win.loader(content="<h1>Loading App...</h1>", color="#fff", after=lambda: win.toggle_fullscreen())

Multiple windows

To create another window for example when a fuction is called you need to use the childwindow property.


def createNewWindow():

    win = Neutrontest.Window("Example", size=(600, 100), childwindow=True)

    win.display(file="secondwindow.html")

    win.show()

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

neutron-web-0.3.1.tar.gz (9.6 kB view hashes)

Uploaded Source

Built Distribution

neutron_web-0.3.1-py3-none-any.whl (10.8 kB view hashes)

Uploaded Python 3

Supported by

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