Skip to main content

ipyvuetify_app

GitHub last commit GitHub license<space><space> PyPI PyPI - Python Version

Short Overview.

ipyvuetify_app is a python package (py>=3.7) with a simple template for writing ipyvuetify application

Examples how your app can look like

pic1 pic2

Application from the box supports theme switcher and navigation over different content by menus on top

A few more examples how header navigation works

pic3 pic4

Installation via pip:

pip install ipyvuetify_app

How to use it

To create an application by the given template you need to create a routing class
That will be in charge of what to show in the main application section
For every selected menu item -> subitem
Then you just give the router to ipyvuetify_app.VueApp(…) and it does all the magic for you
from ipyvuetify_app import VueApp
from ipyvuetify_app import VueAppRouter

vue_app_router_example = VueAppRouter()
VueApp(vue_app_router_example)

How to write a Router

Every router should satisfy 2 conditions:
1) It has method get_main_content(self, item, subitem) which should return page’s main content
2) It has attribute self.dict_list_subitems_by_item with all subitems for every menu item

Simple Router example

class VueAppRouter():

    def __init__(self):
        self.dict_list_subitems_by_item = {}
        for item in range(5):
            list_subitems = [str(subitem) for subitem in range(item, 5 + item)]
            self.dict_list_subitems_by_item[str(item)] = list_subitems

    def get_main_content(self, item, subitem):
        return f"{item} -> {subitem}"

Full VuaApp signature

VueApp(
    vue_app_router,
    list_vw_fab_app_bar_left=None,
    list_vw_fab_app_bar_right=None,
    list_footer_vw_children=None,
)

Arguments:

  1. list_vw_fab_app_bar_left:
    List with ipyvuetify fab icon buttons to put on the left side of Application Header Bar
  2. list_vw_fab_app_bar_right:
    List with ipyvuetify fab icon buttons to put on the right side of Application Header Bar
  3. list_footer_vw_children:
    List with ipyvuetify widgets to put in the footer
    If empty then footer is not shown at all

VuaApp object description

VuaApp is a child of v.App so it has all the parent methods and attributes

Useful Attributes:

  1. self.vw_appbar:
    v.AppBar(app=True, …) - Application top bar
  2. self.vw_navigation_drawer:
    v.NavigationDrawer(app=True, …) - Navigation Drawer at the left side
  3. self.vw_app_main:
    v.Content() - Main section of the application
  4. self.vw_footer:
    v.Footer(app=True, …) - Footer of the application

Useful Methods:

  1. self.update_app_routing():
    When router items were updated please call this method to update application menus

Contacts

License

This project is licensed under the MIT License.

Metadata

Release files for ipyvuetify-app 0.1.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ipyvuetify-app 0.1.6
File Size Uploaded Provenance
ipyvuetify_app-0.1.6.tar.gz 7.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ipyvuetify-app 0.1.6
File Interpreter ABI Platform
ipyvuetify_app-0.1.6-py3-none-any.whl Python 3 none any Details

Total release size: 14.9 kB

Release files / ipyvuetify_app-0.1.6.tar.gz

Download URL ipyvuetify_app-0.1.6.tar.gz
Size 7.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b721ff21d164ec478a25ac8851b4bd8111aa73d4f421e2641ab7a2bcf43e6507
BLAKE2b-256 checksum
How to use checksums
a957fd66233124c2ccbb016c042ecc160d8c7d38f6257d262d793a00337ff033
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.6 CPython/3.8.1 Windows/10

Release files / ipyvuetify_app-0.1.6-py3-none-any.whl

Download URL ipyvuetify_app-0.1.6-py3-none-any.whl
Size 7.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a9c85f7d2e66e5ade65c6ca2ce4974974531829e34a62f982c8202b887492016
BLAKE2b-256 checksum
How to use checksums
31452899157c756a0f035c9f18438924a7cc9b0e4d9ab438fa4347c842c314ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.6 CPython/3.8.1 Windows/10

Security for ipyvuetify-app 0.1.6

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page