Metadata-Version: 2.4
Name: wagtail-sb-material
Version: 0.1.0
Summary: Material design components and pages for Wagtail CMS using MaterializeCSS.
Keywords: cms,django,dynova,materialize,materializecss,softbutterfly,wagtail
Author: Dynova Development Team, zodiacfireworks
Author-email: Dynova Development Team <dev@dynova.io>, zodiacfireworks <martin.vuelta@gmail.com>
License-Expression: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4
Classifier: Framework :: Django :: 5
Classifier: Framework :: Django :: 6
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 5
Classifier: Framework :: Wagtail :: 6
Classifier: Framework :: Wagtail :: 7
Classifier: Framework :: Wagtail :: 8
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: django>=4.2,<7.0
Requires-Dist: django-compressor>=4.0
Requires-Dist: wagtail>=5.2,<9.0
Maintainer: zodiacfireworks
Maintainer-email: zodiacfireworks <martin.vuelta@gmail.com>
Requires-Python: >=3.11.0, <4.0.0
Project-URL: Bug Tracker, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/-/issues
Project-URL: Changelog, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/-/blob/v0.1.0/CHANGELOG.md
Project-URL: Documentation, https://softbutterfly.gitlab.io/open-source/wagtail-sb-material
Project-URL: Download, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/-/archive/v0.1.0/wagtail-sb-material-v0.1.0.tar.gz
Project-URL: Homepage, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material
Project-URL: Issues, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/-/issues
Project-URL: Repository, https://gitlab.com/softbutterfly/open-source/wagtail-sb-material
Description-Content-Type: text/markdown

# Wagtail SB Material

[![PyPI](https://img.shields.io/pypi/v/wagtail-sb-material)](https://pypi.org/project/wagtail-sb-material/)
[![pipeline status](https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/badges/master/pipeline.svg)](https://gitlab.com/softbutterfly/open-source/wagtail-sb-material/-/commits/master)

`wagtail-sb-material` provides MaterializeCSS components and pages for Wagtail CMS.

## Features

- Material design page templates (`MaterialPageStarter`, `MaterialPageParallax`, `MaterialPageArticle`)
- StreamField blocks for cards, buttons, typography, grids, sections, parallax, and media
- MaterializeCSS integration with FontAwesome and PerfectScrollbar support
- Configurable navbar, `Footer`, and `BrandLogo` snippets
- Responsive grid system with containers, rows, and columns

## Requirements

- Python 3.11, 3.12, 3.13, 3.14
- Django 4.2, 5.0, 5.1, 5.2, 6.0
- Wagtail 5.2, 6.x, 7.x, 8.x

## Install

```bash
pip install wagtail-sb-material
```

or with uv:

```bash
uv add wagtail-sb-material
```

## Usage

Add `wagtail_sb_material` to your `INSTALLED_APPS`:

```python
INSTALLED_APPS = [
    # ...
    "wagtail_sb_material",
    # ...
]
```

Use the material page models in your Wagtail site:

```python
from wagtail_sb_material.models import MaterialPageStarter


class HomePage(MaterialPageStarter):
    pass
```

## Development

```bash
git clone https://gitlab.com/softbutterfly/open-source/wagtail-sb-material.git
cd wagtail-sb-material
uv sync
uv run pre-commit install --hook-type pre-commit --hook-type commit-msg
uv run poe test
```

## License

Apache-2.0
