stefanhoelzl / vue.py

Pythonic Vue.js

vue.py

use Vue.js with pure Python

vue.py provides Python bindings for Vue.js. It uses brython to run Python in the browser.

Here is a simple example of an vue.py component

from browser import alert
from vue import VueComponent

class HelloVuePy(VueComponent):
    greeting = "Hello vue.py"

    def greet(self, event):
        alert(self.greeting)

    template = """
    <button @click="greet">click me</button>
    """

HelloVuePy("#app")

Installation

$ pip install vuepy

Development Status

The goal is to provide a solution to write fully-featured Vue applications in pure Python.

To get an overview what currently is supported, have a look at the Documentation.

Have a look here to see whats planned!

See also the Limitations

Documentation

Documentation for the last release is available here.

Documentation fo the current master branch can be found here.

Examples can be found here. These are vue.py versions of the Vue.js examples

Performance

Initial loading times of vue.py apps can be very long. Especially when loading a lot of python files. Still figuring out how to solve this.

Have not done any peformance tests, but havent noticed any issues with performance as soon as the app was fully loaded.

Development

Getting Started

Open in gitpod.io

Get the code

$ git clone https://github.com/stefanhoelzl/vue.py.git
$ cd vue.py

Optionally you can create a venv

$ python -m venv venv
$ source venv/bin/activate

Install required python packages, the chromedriver for selenium and brython

$ make env.up

Format the code

$ make format

Run tests

$ make tests           # runs all tets
$ make tests.unit      # runs unit tests
$ make tests.selenium  # runs selenium tests
$ make tests.cli       # runs cli tests
$ make tests TEST=cli/test_provider.py::TestRenderIndex::test_defaults # run explicit test

Run an example

$ make run APP=examples/tree_view  # makes example available on port 5000

Reset your development environment (clean up, reinstall packages and redownload needed files)

$ make env.down
$ make env.up

Publish a new release

$ release release-candidate

Contributing

see CONTRIBUTING

License

This project is licensed under the MIT License - see the LICENSE file for details