Skip to main content
Warning: You are using the test version of PyPI. This is a pre-production deployment of Warehouse. Changes made here affect the production instance of TestPyPI (testpypi.python.org).
Help us improve Python packaging - Donate today!

Build miraculous web interfaces for your projects.

Project Description
# PopeUI

PopeUI is an opinionated framework that allows you to painlessly build cross-platform web interfaces for your projects.



## Installation

### Via `pip`

```shell
$ pip install popeui
```

### Manually

```shell
$ git clone https://github.com/Dalloriam/popeui
$ cd popeui
$ python setup.py install
```



## Running the tests

```shell
$ python setup.py test
```



## Building a basic web interface with PopeUI

In this example, we will build a web front-end to a text file. Exciting, right?

**Specifications**

* Write lines to a text file.
* Display all lines of a text file.

```python
from popeui.application.base import Application, View

from popeui.widgets.structure import Panel, List
from popeui.widgets.forms import Button, TextBox
from popeui.widgets.text import Title, Span

import os

class FileService(object):
"""Services are the main way of interacting with the outside world with PopeUI.
This service encapsulates all interactions with our file, and will be made
available to our application.
"""
def __init__(self):
if not os.path.isfile('myfile.txt'):
open('myfile.txt', 'a').close()

def get_all(self):
with open("myfile.txt", "rU") as infile:
return list(filter(bool, infile.readlines()))

def add(self, txt):
with open("myfile.txt", "a") as outfile:
outfile.write(txt + "\n")


class MainFileView(View):
"""With PopeUI, views represent the structure of the page currently displayed
as well as the different actions handled by the program.
"""
title = "MyFile.txt"

current_id = 0

def run(self, params=None):
"""The run() method is called when the application is rendering the page to
HTML. It is responsible for building the DOM and registering the events
(originating from both the server and the client) handled by the page.
"""

# We create a Panel() object and anchor it to the root of the page.
# Panel() is analogous to <div> in HTML.
main_panel = Panel(id="pnlMain", parent=self.root)
Title(id="pageTitle", text="Contents of myfile.txt", parent=main_panel)

# Here, we define a List() object. Contrary to Panel(), List() is more than
# a simple wrapper around <ul>. The List object provides an interface
# similar to python lists, and handles automatically the updating of the
# client view on a call to append() or remove()
self.lines_list = List(id="lstLines", parent=main_panel)

# We get the list of active services from the view's context & call the
# method allowing us to retrieve all lines in the file.
for ln in self.ctx.services["FileService"].get_all():
self.append_line(ln)

self.txtNew = TextBox(id="txtNew", name="txtNew", parent=main_panel)
btn = Button(id="btnSubmit", text="Add Line", parent=main_panel)

# Note: The framework handles seamlessly the forwarding of events from the
# client to the server, so we can set a server-side method as callback
# for a client event.
self.on("click", btn, self.create_line)

def append_line(self, ln):
self.lines_list.append(Span(id="line_" + str(self.current_id), text=ln))
self.current_id += 1

def create_line(self):
new_line = self.txtNew.text
self.ctx.services["FileService"].add(new_line)
self.append_line(new_line)


class FileApp(Application):
"""The Application object is the central object tying your PopeUI app together.
It holds all the information common to all views, as well as view and service
definitions.
"""

# The base title of the app.
# The actual title of the page is set by App.base_title.format(view.title)
base_title = "{0} | TextFileManager"

def __init__(self, debug=False):
super(FileApp, self).__init__(debug)

self.views["index"] = MainFileView

# Services are instanciated on app startup and are kept running for the
# entire lifetime of the app.
self.services["FileService"] = FileService

if __name__ == "__main__":
app = FileApp(debug=True)
app.run()
```

**Getting it running**

To start the app, simply run

```shell
$ python [appfilename].py
```

and browse to `http://localhost:8080/index` to test your app:

![App running](http://i.imgur.com/rWupXcB.png)

Not so pretty, but it works great!



## Requirements

* Python 3.5.1 (Not tested yet on earlier versions, should work with 3.x)
Release History

Release History

This version
History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
popeui-0.0.1-py2-none-any.whl (17.4 kB) Copy SHA256 Checksum SHA256 py2 Wheel Jul 16, 2016
popeui-0.0.1-py3-none-any.whl (17.4 kB) Copy SHA256 Checksum SHA256 py3 Wheel Jul 16, 2016
popeui-0.0.1.tar.gz (12.0 kB) Copy SHA256 Checksum SHA256 Source Jul 16, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting