Metadata-Version: 2.1
Name: django-semantic-admin
Version: 0.1.5
Summary: Django Semantic UI Admin theme
Home-page: https://github.com/globophobe/django-semantic-admin
License: MIT
Keywords: django,admin,theme
Author: Alex
Author-email: globophobe@gmail.com
Requires-Python: >=3.6,<4.0
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: django (>=3.0)
Requires-Dist: django-taggit (>=1.3.0,<2.0.0)
Project-URL: Repository, https://github.com/globophobe/django-semantic-admin
Description-Content-Type: text/markdown

A Django Semantic UI Admin theme
--------------------------------
Django [Semantic UI](https://semantic-ui.com/) Admin is a completely free (MIT) admin theme for Django. Actually, this is my 3rd admin theme for Django. The first was forgettable, and the second was with Pure CSS. Pure CSS was great, but lacked JavaScript components.

Semantic UI looks professional, and has great JavaScript components.

Why?
----
* Looks professional, with a nice sidebar.
* Resonsive design, even [tables can stack](https://semantic-ui.com/collections/table.html#stacking) responsively on mobile.
* JavaScript datepicker and timepicker components.
* JavaScript selects, including multiple selections, which integrate well with Django autocomplete fields.
* Semantic UI has libraries for [React](https://react.semantic-ui.com/) and [Vue](https://semantic-ui-vue.github.io/#/), in addition to jQuery. This means this package can be used to style the admin, and custom views can be added with React or Vue components with the same style.

Install
-------

Install from PyPI:

```
pip install django-semantic-admin
```

Add to `settings.py` before `django.contrib.admin`:

```
INSTALLED_APPS = [
  "semantic_admin",
  "django.contrib.admin",
  ...
]
```

Usage
-----

Instead of `admin.ModelAdmin`, `admin.StackedInline`, or `admin.TabularInline`:

```
class ExampleStackedInline(admin.StackedInline):
  pass

class ExampleTabularInline(admin.TabularInline):
  pass

class ExampleAdmin(admin.ModelAdmin):
  inlines = (ExampleStackedInline, ExampleTabularInline)
```

Inherit from their `Semantic` equivalents:

```
from semantic_admin import SemanticModelAdmin, SemanticStackedInline, SemanticTabularInline

class ExampleStackedInline(SemanticStackedInline):
  pass

class ExampleTabularInline(SemanticTabularInline):
  pass

class ExampleAdmin(SemanticModelAdmin):
  inlines = (ExampleStackedInline, ExampleTabularInline)
```

Notes
-----
Please note, this package uses [Fomantic UI](https://fomantic-ui.com/) the official community fork of Semantic UI.

