Metadata-Version: 2.1
Name: django-patternfly4
Version: 0.0.3
Summary: Patternfly support for Django projects
Home-page: https://github.com/ayaseen/django-patternfly4
License: BSD-3-Clause
Keywords: django,django-patternfly4,patternfly,theming
Author: ayaseen
Author-email: amjad.a.yaseen@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Provides-Extra: docs
Requires-Dist: beautifulsoup4 (>=4.11.1,<5.0.0)
Requires-Dist: django (>=4.0,<5.0)
Requires-Dist: importlib-metadata (<3); python_version < "3.10"
Requires-Dist: m2r2 (>=0.3.2,<0.4.0); extra == "docs"
Requires-Dist: sphinx (>=5.1.1,<6.0.0); extra == "docs"
Requires-Dist: sphinx_rtd_theme (>=1.0.0,<2.0.0); extra == "docs"
Project-URL: Documentation, https://django-patternfly4.readthedocs.io/
Project-URL: Repository, https://github.com/ayaseen/django-patternfly4
Description-Content-Type: text/markdown

# django-patternfly



Patternfly integration for Django. Ported from [django-bootstrap4](https://github.com/zostera/django-bootstrap4)

DISCLAIMER: This is a port done over the weekend and is a very poorly featured
package. The only purpose for this currently is to provide a CSS to be used in
your project templates

## Goal

The goal of this project is to seamlessly blend Django and PatternFly.

## Requirements

Python 3.9 or newer with Django >= 4.0 or newer.

## Documentation

The full documentation is (will be) at https://django-patternly4.readthedocs.io/

## Installation

1. Install using pip:

   ```shell script
   pip install django-patternfly4
   ```


2. Add to `INSTALLED_APPS` in your `settings.py`:

   ```python
   INSTALLED_APPS = (
       # ...
       "patternfly",
       # ...
   )
   ```

3. In your templates, load the `patternfly` library and use the `patternfly_*` tags:

## Example template

```djangotemplate
{% load patternfly %}

<html>
    <head>
        {% patternfly_css %}
    </head>
    <body>
        {% block patternfly_content %}
            Main Content
        {% endblock %}
    </body>
</html>
```

## Development

Install poetry

```shell script
$ pip install poetry
```

## Bugs and suggestions

If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.

https://github.com/ayaseen/django-patternfly4/issues

## License

You can use this under BSD-3-Clause. See [LICENSE](LICENSE) file for details.

## Author

Developed and maintained by Amjad Yaseen

Please see [AUTHORS.md](AUTHORS.md) for a list of contributors.

