pydzn 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

pydzn-0.1.4.dist-info/METADATA

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: pydzn
+Version: 0.1.4
+Summary: Build complex websites in pure python with pydzn layout builder, semantic css classes and an extendable components library for server-side rendering.
+Author-email: Ryan Kirkish <ryan@foo.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/anthonyrka/pydzn
+Project-URL: Repository, https://github.com/anthonyrka/pydzn
+Project-URL: Issues, https://github.com/anthonyrka/pydzn/issues
+Keywords: design-system,css,utility-classes,jinja2,components,grid,htmx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: Flask
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Jinja2>=3.1
+Provides-Extra: flask
+Requires-Dist: Flask>=2.3; extra == "flask"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: black>=24; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# pydzn
+*Pronounced:* **[paɪ dɪˈzaɪn]** — “**pie design**” (aka **py-design**)
+
+Build full websites in Python with server-side components, a design system that leverages semantic classes, and a grid layout builder.
+
+## What is pydzn
+pydzn or "py design" is a lightweight python library that makes it easy to design, build and serve complex websites all in python. It provides an api into CSS-grid for designing layouts and serves as a light-weight website builder with a built-in, and extendable, component library as well as a library for setting CSS semantic classes.
+
+
+## Examples
+- For examples see: [pydzn-website](https://github.com/anthonyrka/pydzn-website)
+
+## References
+- See [PyPI](https://pypi.org/project/pydzn/)
+
+
+## A website builder for python developers (not front-end developers)
+The layout builder contains a debug mode allowing you to visualize the structure of your layout. Each named region is a slot which can be passed a sub-layout or a component in the layout's render function.
+
+<p align="center">
+  <img src="docs/website_builder_sortof.gif" alt="mobile" width="640">
+</p>
+
+## Responsive is built-in
+Build responsive layouts with pydzn
+
+<p align="center">
+  <img src="docs/pydzn_responsive.gif" alt="mobile" width="640">
+</p>
+
+The above layouts are combined desktop and mobile versions:
+```python
+
+from pydzn.grid_builder import layout_builder
+
+# This is the Main App layout structure we've created below for DESKTOP
+"""
+                    column::left_column    column::main_column
+row:header_row      region:left_sidebar    region:appbar
+row:content_row     region:left_sidebar    region:content
+
+The layout accepts the following components in render function signature: left_sidebar, appbar, content
+"""
+AppMainLayout = (
+    layout_builder()
+    .fill_height("100vh", property="height") # sets up the page to restrict height to view height
+    .columns(left_column=LEFT_SIDEBAR_WIDTH, main_column="1fr") # split the main layout into two columns: sidebar and main
+    .rows(header_row=HEADER_HEIGHT, content_row="1fr") # add 2 rows: a header section and a content section stacked 
+    .region("left_sidebar", col="left_column", row="header_row", row_span=2) # place the sidebar into the left_sidebar column in the first row and span both rows
+    .region("appbar", col="main_column", row="header_row", col_span=1) # Add the appbar to the right of sidebar in the main section and span the last row
+    .region("content", col="main_column", row="content_row") # declare the empty content section which is the last row in main
+    .build(name="AppMainLayout")
+)
+
+# This is the Main App layout structure we've created below for MOBILE
+"""
+                    column::main_column
+row:header_row      region:appbar
+row:content_row     region:content
+
+The layout accepts the following components in render function signature: appbar, content
+"""
+AppMainMobileLayout = (
+    layout_builder()
+    .fill_height("100vh", property="height")
+    .columns(main_column="1fr")
+    .rows(header_row=HEADER_HEIGHT_MOBILE, content_row="1fr")
+    .region("appbar",  col="main_column", row="header_row")
+    .region("content", col="main_column", row="content_row")
+    .build(name="AppMainMobileLayout")
+)
+
+# ----- App header menu slots -----#
+AppHeaderMenuLayout = (
+    layout_builder()
+    # make the inner grid fill the parent (the appbar row), not the viewport
+    .fill_height("100%", property="height") # was min-height:100vh (implicit default)
+    .columns(brand=BRAND_WIDTH, spacer="1fr", tasks=APP_MENU_WIDTH, customers=APP_MENU_WIDTH, orders=APP_MENU_WIDTH, notifications=APP_MENU_WIDTH, user_profile=APP_MENU_WIDTH)
+    .rows(app_header_main=f"minmax({HEADER_HEIGHT}px, auto)") # these items don't take up the full height of the app header unless you set it here
+    .region("brand", col="brand", row="app_header_main")
+    .region("spacer", col="spacer", row="app_header_main") # empty; pushes the rest right
+    .region("tasks", col="tasks", row="app_header_main")
+    .region("customers", col="customers", row="app_header_main")
+    .region("orders", col="orders", row="app_header_main")
+    .region("notifications", col="notifications", row="app_header_main")
+    .region("user_profile", col="user_profile", row="app_header_main")
+    .build(name="AppHeaderMenuLayout")
+)
+
+# ----- App header mobile menu layout ----#
+AppHeaderMobileMenuLayout = (
+    layout_builder()
+    .fill_height("100%", property="height")
+    .columns(brand_col=BRAND_WIDTH, spacer_col="1fr", hamburger_menu_col=100)
+    .rows(app_header_mobile_row=f"minmax({HEADER_HEIGHT_MOBILE}px, auto)") # this container holds the app header for mobile layout so height must match
+    .region("brand", col="brand_col", row="app_header_mobile_row")
+    .region("hamburger_menu", col="hamburger_menu_col", row="app_header_mobile_row")
+    .build(name="AppHeaderMobileMenuLayout")
+)
+
+```
+
+These layouts contain render functions with a signature containing the named slots for variables, in the case of AppMainMobileLayout, the hamburger_menu slot is passed a built-in hamburger menu component:
+
+```python
+from pydzn.components import NavItem, Text, HamburgerMenu
+
+# Right-side full-height drawer
+menu_btn = HamburgerMenu(
+    mode="right",
+    drawer_width=320,
+    show_backdrop=True,
+    children=drop_down_mobile,
+    dzn="bg-[white]",   # forwarded to the panel automatically
+    panel_dzn="p-[24px]" # this is how you set the semantic css classes for the drawer (panel)
+).render()
+
+
+mobile_html = AppHeaderMobileMenuLayout(
+    debug=debug,
+    region_dzn = {
+        "brand": "flex justify-center items-center",
+        "hamburger_menu": "flex justify-center items-center"
+    }
+).render(
+    brand=brand,
+    hamburger_menu=menu_btn
+)
+```
+
+
+

pydzn-0.1.4.dist-info/RECORD

@@ -0,0 +1,27 @@
+pydzn/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydzn/base_component.py,sha256=YkfAF2AN87YioV0qK-XhJlGpUj0qfA201V0W0ituIOE,5304
+pydzn/dzn.py,sha256=Ph_dxXBF9Ju2GEEKJ662bzt9Hr4pJiiyuA-VJD0T_kE,16702
+pydzn/grid_builder.py,sha256=7X2yn7kZMn25gPgRr4HT7nHozzjDwDon3RoarRZi6R0,13188
+pydzn/responsive.py,sha256=oDJuxGjHQHvjSwgPc-ZqRiOwpKY4evYRnuKbPca5Igc,686
+pydzn/variants.py,sha256=jFEqe5RcdlnLjeAI-o6jjGUZbaksk23-0PBuUb8N5W8,7809
+pydzn/components/__init__.py,sha256=Z4Jz6l8LXQKBpNFaahNaAtky6XECQXLDi-qDmXyzwFo,359
+pydzn/components/button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pydzn/components/button/component.py,sha256=yxnlip5r-Ge1ma8XKnE0zsz42u1BRwzoOKoi3TeIak4,2525
+pydzn/components/button/template.html,sha256=RD0XPzHG0DlWgwlODNNs6PU4yp0arxEsajmGoB8k2vI,99
+pydzn/components/card/component.py,sha256=eDsl9IaP3zOzrgd1Fp_lk87ug-wVVGZSfaFE4sGspng,2731
+pydzn/components/card/template.html,sha256=xIHvf33q7nVPeNPgSn_wVo5dyNaRiX2quWyBVtk1IDw,89
+pydzn/components/drawer/component.py,sha256=F3BeNaBbrYKa2X9D_FjfBXgwqe2Qo_YR8qMinrPHCag,355
+pydzn/components/drawer/template.html,sha256=xIHvf33q7nVPeNPgSn_wVo5dyNaRiX2quWyBVtk1IDw,89
+pydzn/components/hamburger_menu/component.py,sha256=qZ3I5DtGA-ThxkSxyNgc-X-_EkO61kV70MK_Y1WuLgY,8106
+pydzn/components/hamburger_menu/template.html,sha256=BpFjn70qDyRbeORBKBK3Uz1oJgVdZD7x7_w9tr9DPMw,64
+pydzn/components/nav_item/component.py,sha256=kcyWBHqPhsSWxENkK3d8Ryga6eOcgvfG5cKYUL2HZvc,7525
+pydzn/components/nav_item/template.html,sha256=BpFjn70qDyRbeORBKBK3Uz1oJgVdZD7x7_w9tr9DPMw,64
+pydzn/components/sidebar/component.py,sha256=MdZyjtjZexh1d1BA3X0Hq4lRHftuYIWz9e1Cqx7dzic,2058
+pydzn/components/sidebar/template.html,sha256=BpFjn70qDyRbeORBKBK3Uz1oJgVdZD7x7_w9tr9DPMw,64
+pydzn/components/text/component.py,sha256=aAkhQXtUPLbApk6Cib-CVo-vQmsNvJnlHxs5QPv64pc,409
+pydzn/components/text/template.html,sha256=RD0XPzHG0DlWgwlODNNs6PU4yp0arxEsajmGoB8k2vI,99
+pydzn-0.1.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pydzn-0.1.4.dist-info/METADATA,sha256=sk8t9fgRk0rpqnNgknBtiKKwnxCqIBkyga92-2nXA88,7279
+pydzn-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pydzn-0.1.4.dist-info/top_level.txt,sha256=QPNKgtzCjxN7JSGId_GxBlQaq7X8yNEzCUrYbKAXudA,6
+pydzn-0.1.4.dist-info/RECORD,,

pydzn-0.1.2.dist-info/METADATA

@@ -1,38 +0,0 @@
-Metadata-Version: 2.4
-Name: pydzn
-Version: 0.1.2
-Summary: Tiny design-system utilities (Tailwind-like), composable HTML components, and a grid layout builder for Python/Jinja apps.
-Author-email: Ryan Kirkish <ryan@foo.com>
-License: Apache-2.0
-Project-URL: Homepage, https://github.com/anthonyrka/pydzn
-Project-URL: Repository, https://github.com/anthonyrka/pydzn
-Project-URL: Issues, https://github.com/anthonyrka/pydzn/issues
-Keywords: design-system,css,utility-classes,jinja2,components,grid,htmx
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Framework :: Flask
-Classifier: Topic :: Internet :: WWW/HTTP
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: Jinja2>=3.1
-Provides-Extra: flask
-Requires-Dist: Flask>=2.3; extra == "flask"
-Provides-Extra: dev
-Requires-Dist: pytest>=8; extra == "dev"
-Requires-Dist: ruff>=0.5; extra == "dev"
-Requires-Dist: black>=24; extra == "dev"
-Requires-Dist: mypy>=1.10; extra == "dev"
-Requires-Dist: build>=1.2; extra == "dev"
-Requires-Dist: twine>=5; extra == "dev"
-Dynamic: license-file
-
-# pydzn
-Python web components for server-side rendering

pydzn-0.1.2.dist-info/RECORD

@@ -1,13 +0,0 @@
-pydzn/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pydzn/base_component.py,sha256=iXjT12Pgqgbix9Ebm7KzimDpwrkOxSwzEzK12aP0qx4,5342
-pydzn/dzn.py,sha256=mdbDtI30smAjfjcnGrI2tyRVJlKZhrF0MbaPDqF1pqw,11776
-pydzn/grid_builder.py,sha256=Qtxx8Si_vIqV7dwOgAs6jPUIJm0F_IvZtD2BrRWKnb8,9771
-pydzn/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pydzn/components/button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pydzn/components/button/component.py,sha256=KF9dDoIXZ4cQ_z_g2nDrzSjr0BEJ6skLF5ur0eqgxAw,1028
-pydzn/components/button/template.html,sha256=RD0XPzHG0DlWgwlODNNs6PU4yp0arxEsajmGoB8k2vI,99
-pydzn-0.1.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pydzn-0.1.2.dist-info/METADATA,sha256=7Nnt_30H2g9nkza7we-Mcxpb1P7krEKXRQICsfSkFac,1565
-pydzn-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pydzn-0.1.2.dist-info/top_level.txt,sha256=QPNKgtzCjxN7JSGId_GxBlQaq7X8yNEzCUrYbKAXudA,6
-pydzn-0.1.2.dist-info/RECORD,,