django-admin-interface


Namedjango-admin-interface JSON
Version 0.16.2 PyPI version JSON
download
home_pagehttps://github.com/fabiocaccamo/django-admin-interface
Summarydjango-admin-interface is a modern responsive flat admin interface customizable by the admin itself.
upload_time2021-04-23 13:01:02
maintainer
docs_urlNone
authorFabio Caccamo
requires_python
licenseMIT
keywords django admin interface responsive flat theme custom ui
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![](https://img.shields.io/pypi/pyversions/django-admin-interface.svg?color=3776AB&logo=python&logoColor=white)](https://www.python.org/)
[![](https://img.shields.io/pypi/djversions/django-admin-interface?color=0C4B33&logo=django&logoColor=white&label=django)](https://www.djangoproject.com/)

[![](https://img.shields.io/pypi/v/django-admin-interface.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/django-admin-interface/)
[![](https://pepy.tech/badge/django-admin-interface)](https://pepy.tech/project/django-admin-interface)
[![](https://img.shields.io/github/stars/fabiocaccamo/django-admin-interface?logo=github)](https://github.com/fabiocaccamo/django-admin-interface/)
[![](https://badges.pufler.dev/visits/fabiocaccamo/django-admin-interface?label=visitors&color=blue)](https://badges.pufler.dev)
[![](https://img.shields.io/pypi/l/django-admin-interface.svg?color=blue)](https://github.com/fabiocaccamo/django-admin-interface/blob/master/LICENSE.txt)

[![](https://img.shields.io/travis/fabiocaccamo/django-admin-interface?logo=travis&label=build)](https://travis-ci.org/fabiocaccamo/django-admin-interface)
[![](https://img.shields.io/codecov/c/gh/fabiocaccamo/django-admin-interface?logo=codecov)](https://codecov.io/gh/fabiocaccamo/django-admin-interface)
[![](https://img.shields.io/codacy/grade/21cb657283c04e70b56fb935277a1ad1?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/django-admin-interface)
[![](https://img.shields.io/codeclimate/maintainability/fabiocaccamo/django-admin-interface?logo=code-climate)](https://codeclimate.com/github/fabiocaccamo/django-admin-interface/)
[![](https://requires.io/github/fabiocaccamo/django-admin-interface/requirements.svg?branch=master)](https://requires.io/github/fabiocaccamo/django-admin-interface/requirements/?branch=master)

# django-admin-interface
django-admin-interface is a modern **responsive flat admin interface customizable by the admin itself**.

![django-admin-interface-preview](https://user-images.githubusercontent.com/1035294/35631521-64b0cab8-06a4-11e8-8f57-c04fdfbb7e8b.gif)

## Features
- Beautiful default **django-theme**
- Themes management and customization *(you can **customize admin title, logo and colors**)*
- Responsive
- Related modal *(instead of the old popup window)*
- Environment name/marker
- Language chooser
- List filter dropdown
- `NEW` **List filter sticky**
- `NEW` **Form controls sticky** *(pagination and save/delete buttons)*
- Compatibility / Style optimizations for:
  - `django-ckeditor`
  - `django-dynamic-raw-id`
  - `django-json-widget`
  - `django-modeltranslation`
  - `django-tabbed-admin`
  - `sorl-thumbnail`

## Installation
- Run `pip install django-admin-interface`
- Add `admin_interface`, `flat_responsive`, `flat` and `colorfield` to `settings.INSTALLED_APPS` **before** `django.contrib.admin`
```python
INSTALLED_APPS = (
    #...
    'admin_interface',
    'flat_responsive', # only if django version < 2.0
    'flat', # only if django version < 1.9
    'colorfield',
    #...
    'django.contrib.admin',
    #...
)

X_FRAME_OPTIONS='SAMEORIGIN' # only if django version >= 3.0
```
- Run ``python manage.py migrate``
- Run ``python manage.py collectstatic``
- Restart your application server

#### Upgrade
- Run `pip install django-admin-interface --upgrade`
- Run ``python manage.py migrate`` *(add* ``--fake-initial`` *if you are upgrading from 0.1.0 version)*
- Run ``python manage.py collectstatic --clear``
- Restart your application server

## Optional themes
This package ships with optional themes as fixtures, they can be installed using the [loaddata admin command](https://docs.djangoproject.com/en/1.11/ref/django-admin/#django-admin-loaddata). Optional themes are activated on installation.

##### [Django](https://www.djangoproject.com/) theme (default):
Run ``python manage.py loaddata admin_interface_theme_django.json``

##### [Bootstrap](http://getbootstrap.com/) theme:
Run ``python manage.py loaddata admin_interface_theme_bootstrap.json``

##### [Foundation](http://foundation.zurb.com/) theme:
Run ``python manage.py loaddata admin_interface_theme_foundation.json``

##### [U.S. Web Design Standards](https://standards.usa.gov/) theme:
Run ``python manage.py loaddata admin_interface_theme_uswds.json``

### Add more themes
You can add a theme you've created through the admin to this repository by [sending us a PR](http://makeapullrequest.com/). Here are the steps to follow to add:

1. Export your exact theme as fixture using the `dumpdata` admin command:
``python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N``

2. Copy the generated json file into the fixtures folder *(making sure its name starts with* `admin_interface_theme_` *to avoid clashes with fixtures that might be provided by other third party apps)*.

3. Remove the `"pk"` from the fixture and make sure the `active` field is set to `true` *(in this way a theme is automatically activated when installed)*.

4. Edit the section above to document your theme.

### Add theme support to third-party libraries
You can add **theme support to existing third-party libraries** using the following **css variables**:

- `--admin-interface-title-color`
- `--admin-interface-logo-color`
- `--admin-interface-env-color`
- `--admin-interface-header-background-color:`
- `--admin-interface-header-text-color`
- `--admin-interface-header-link-color`
- `--admin-interface-header-link_hover-color`
- `--admin-interface-module-background-color`
- `--admin-interface-module-background-selected-color`
- `--admin-interface-module-text-color`
- `--admin-interface-module-link-color`
- `--admin-interface-module-link-selected-color`
- `--admin-interface-module-link-hover-color`
- `--admin-interface-generic-link-color`
- `--admin-interface-generic-link-hover-color`
- `--admin-interface-save-button-background-color`
- `--admin-interface-save-button-background-hover-color`
- `--admin-interface-save-button-text-color`
- `--admin-interface-delete-button-background-color`
- `--admin-interface-delete-button-background-hover-color`
- `--admin-interface-delete-button-text-color`
- `--admin-interface-related-modal-background-color`
- `--admin-interface-related-modal-background-opacity`


## Screenshots
###### Admin login
![django-admin-interface_login](https://cloud.githubusercontent.com/assets/1035294/11240233/55c8d4ba-8df1-11e5-9568-00fdc987ede8.gif)
---
###### Admin dashboard
![django-admin-interface_dashboard](https://cloud.githubusercontent.com/assets/1035294/11240239/627c0362-8df1-11e5-81fa-216366a5d8da.gif)
---
###### Admin themes management
![django-admin-interface_themes_management](https://cloud.githubusercontent.com/assets/1035294/11240245/6cd1c342-8df1-11e5-928b-f22217474d3d.gif)
---
###### Admin theme customization
![django-admin-interface_theme_customization](https://cloud.githubusercontent.com/assets/1035294/11240250/7350d942-8df1-11e5-9b28-f2f54c333cdc.gif)

## FAQ
- #### I already have a custom `base_site.html`, how can I make it work?

You can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add `{% extends "admin_interface:admin/base_site.html" %}` to your `base_site.html`

## Testing
```bash
# create python virtual environment
virtualenv testing_django_admin_interface

# activate virtualenv
cd testing_django_admin_interface && . bin/activate

# clone repo
git clone https://github.com/fabiocaccamo/django-admin-interface.git src && cd src

# install dependencies
pip install -r requirements.txt

# run tests
tox
# or
python setup.py test
# or
python -m django test --settings "tests.settings"
```

## License
Released under [MIT License](LICENSE.txt).

---

## Supporting

I would like to spend more time on this project, especially to improve it and adding new features.

As everyone knows open-source projects takes up a lot of time that is unpaid. :money_with_wings:

If you are using this package in commercial project(s), please consider the idea to become a sponsor or donating once:

- [GitHub Sponsor](https://github.com/sponsors/fabiocaccamo)
- [PayPal](https://www.paypal.me/fabiocaccamo)
- BTC: bc1q2t0pv8z3udpyuvfnx5kskhqdad4dcvtfuzmvjw
- ETH: 0x8B55Fb7798b5A9F797A4455C00821B6e53daca74

## See also

- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. 🎨

- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. ⚙️

- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. 🚧 🛠️

- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. ↪️

- [`django-treenode`](https://github.com/fabiocaccamo/django-treenode) - probably the best abstract model / admin for your tree based stuff. 🌳

- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. 📘

- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. 🇮🇹 💳

- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. 🧟‍♂️



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/fabiocaccamo/django-admin-interface",
    "name": "django-admin-interface",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "django,admin,interface,responsive,flat,theme,custom,ui",
    "author": "Fabio Caccamo",
    "author_email": "fabio.caccamo@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/69/46/1e9cdcea19d3542fd3f1ba17ca87821dadb66b033ef7cab03fadbc1c55ca/django-admin-interface-0.16.2.tar.gz",
    "platform": "",
    "description": "[![](https://img.shields.io/pypi/pyversions/django-admin-interface.svg?color=3776AB&logo=python&logoColor=white)](https://www.python.org/)\n[![](https://img.shields.io/pypi/djversions/django-admin-interface?color=0C4B33&logo=django&logoColor=white&label=django)](https://www.djangoproject.com/)\n\n[![](https://img.shields.io/pypi/v/django-admin-interface.svg?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/django-admin-interface/)\n[![](https://pepy.tech/badge/django-admin-interface)](https://pepy.tech/project/django-admin-interface)\n[![](https://img.shields.io/github/stars/fabiocaccamo/django-admin-interface?logo=github)](https://github.com/fabiocaccamo/django-admin-interface/)\n[![](https://badges.pufler.dev/visits/fabiocaccamo/django-admin-interface?label=visitors&color=blue)](https://badges.pufler.dev)\n[![](https://img.shields.io/pypi/l/django-admin-interface.svg?color=blue)](https://github.com/fabiocaccamo/django-admin-interface/blob/master/LICENSE.txt)\n\n[![](https://img.shields.io/travis/fabiocaccamo/django-admin-interface?logo=travis&label=build)](https://travis-ci.org/fabiocaccamo/django-admin-interface)\n[![](https://img.shields.io/codecov/c/gh/fabiocaccamo/django-admin-interface?logo=codecov)](https://codecov.io/gh/fabiocaccamo/django-admin-interface)\n[![](https://img.shields.io/codacy/grade/21cb657283c04e70b56fb935277a1ad1?logo=codacy)](https://www.codacy.com/app/fabiocaccamo/django-admin-interface)\n[![](https://img.shields.io/codeclimate/maintainability/fabiocaccamo/django-admin-interface?logo=code-climate)](https://codeclimate.com/github/fabiocaccamo/django-admin-interface/)\n[![](https://requires.io/github/fabiocaccamo/django-admin-interface/requirements.svg?branch=master)](https://requires.io/github/fabiocaccamo/django-admin-interface/requirements/?branch=master)\n\n# django-admin-interface\ndjango-admin-interface is a modern **responsive flat admin interface customizable by the admin itself**.\n\n![django-admin-interface-preview](https://user-images.githubusercontent.com/1035294/35631521-64b0cab8-06a4-11e8-8f57-c04fdfbb7e8b.gif)\n\n## Features\n- Beautiful default **django-theme**\n- Themes management and customization *(you can **customize admin title, logo and colors**)*\n- Responsive\n- Related modal *(instead of the old popup window)*\n- Environment name/marker\n- Language chooser\n- List filter dropdown\n- `NEW` **List filter sticky**\n- `NEW` **Form controls sticky** *(pagination and save/delete buttons)*\n- Compatibility / Style optimizations for:\n  - `django-ckeditor`\n  - `django-dynamic-raw-id`\n  - `django-json-widget`\n  - `django-modeltranslation`\n  - `django-tabbed-admin`\n  - `sorl-thumbnail`\n\n## Installation\n- Run `pip install django-admin-interface`\n- Add `admin_interface`, `flat_responsive`, `flat` and `colorfield` to `settings.INSTALLED_APPS` **before** `django.contrib.admin`\n```python\nINSTALLED_APPS = (\n    #...\n    'admin_interface',\n    'flat_responsive', # only if django version < 2.0\n    'flat', # only if django version < 1.9\n    'colorfield',\n    #...\n    'django.contrib.admin',\n    #...\n)\n\nX_FRAME_OPTIONS='SAMEORIGIN' # only if django version >= 3.0\n```\n- Run ``python manage.py migrate``\n- Run ``python manage.py collectstatic``\n- Restart your application server\n\n#### Upgrade\n- Run `pip install django-admin-interface --upgrade`\n- Run ``python manage.py migrate`` *(add* ``--fake-initial`` *if you are upgrading from 0.1.0 version)*\n- Run ``python manage.py collectstatic --clear``\n- Restart your application server\n\n## Optional themes\nThis package ships with optional themes as fixtures, they can be installed using the [loaddata admin command](https://docs.djangoproject.com/en/1.11/ref/django-admin/#django-admin-loaddata). Optional themes are activated on installation.\n\n##### [Django](https://www.djangoproject.com/) theme (default):\nRun ``python manage.py loaddata admin_interface_theme_django.json``\n\n##### [Bootstrap](http://getbootstrap.com/) theme:\nRun ``python manage.py loaddata admin_interface_theme_bootstrap.json``\n\n##### [Foundation](http://foundation.zurb.com/) theme:\nRun ``python manage.py loaddata admin_interface_theme_foundation.json``\n\n##### [U.S. Web Design Standards](https://standards.usa.gov/) theme:\nRun ``python manage.py loaddata admin_interface_theme_uswds.json``\n\n### Add more themes\nYou can add a theme you've created through the admin to this repository by [sending us a PR](http://makeapullrequest.com/). Here are the steps to follow to add:\n\n1. Export your exact theme as fixture using the `dumpdata` admin command:\n``python manage.py dumpdata admin_interface.Theme --indent 4 -o admin_interface_theme_{{name}}.json --pks=N``\n\n2. Copy the generated json file into the fixtures folder *(making sure its name starts with* `admin_interface_theme_` *to avoid clashes with fixtures that might be provided by other third party apps)*.\n\n3. Remove the `\"pk\"` from the fixture and make sure the `active` field is set to `true` *(in this way a theme is automatically activated when installed)*.\n\n4. Edit the section above to document your theme.\n\n### Add theme support to third-party libraries\nYou can add **theme support to existing third-party libraries** using the following **css variables**:\n\n- `--admin-interface-title-color`\n- `--admin-interface-logo-color`\n- `--admin-interface-env-color`\n- `--admin-interface-header-background-color:`\n- `--admin-interface-header-text-color`\n- `--admin-interface-header-link-color`\n- `--admin-interface-header-link_hover-color`\n- `--admin-interface-module-background-color`\n- `--admin-interface-module-background-selected-color`\n- `--admin-interface-module-text-color`\n- `--admin-interface-module-link-color`\n- `--admin-interface-module-link-selected-color`\n- `--admin-interface-module-link-hover-color`\n- `--admin-interface-generic-link-color`\n- `--admin-interface-generic-link-hover-color`\n- `--admin-interface-save-button-background-color`\n- `--admin-interface-save-button-background-hover-color`\n- `--admin-interface-save-button-text-color`\n- `--admin-interface-delete-button-background-color`\n- `--admin-interface-delete-button-background-hover-color`\n- `--admin-interface-delete-button-text-color`\n- `--admin-interface-related-modal-background-color`\n- `--admin-interface-related-modal-background-opacity`\n\n\n## Screenshots\n###### Admin login\n![django-admin-interface_login](https://cloud.githubusercontent.com/assets/1035294/11240233/55c8d4ba-8df1-11e5-9568-00fdc987ede8.gif)\n---\n###### Admin dashboard\n![django-admin-interface_dashboard](https://cloud.githubusercontent.com/assets/1035294/11240239/627c0362-8df1-11e5-81fa-216366a5d8da.gif)\n---\n###### Admin themes management\n![django-admin-interface_themes_management](https://cloud.githubusercontent.com/assets/1035294/11240245/6cd1c342-8df1-11e5-928b-f22217474d3d.gif)\n---\n###### Admin theme customization\n![django-admin-interface_theme_customization](https://cloud.githubusercontent.com/assets/1035294/11240250/7350d942-8df1-11e5-9b28-f2f54c333cdc.gif)\n\n## FAQ\n- #### I already have a custom `base_site.html`, how can I make it work?\n\nYou can use [django-apptemplates](https://github.com/bittner/django-apptemplates), then add `{% extends \"admin_interface:admin/base_site.html\" %}` to your `base_site.html`\n\n## Testing\n```bash\n# create python virtual environment\nvirtualenv testing_django_admin_interface\n\n# activate virtualenv\ncd testing_django_admin_interface && . bin/activate\n\n# clone repo\ngit clone https://github.com/fabiocaccamo/django-admin-interface.git src && cd src\n\n# install dependencies\npip install -r requirements.txt\n\n# run tests\ntox\n# or\npython setup.py test\n# or\npython -m django test --settings \"tests.settings\"\n```\n\n## License\nReleased under [MIT License](LICENSE.txt).\n\n---\n\n## Supporting\n\nI would like to spend more time on this project, especially to improve it and adding new features.\n\nAs everyone knows open-source projects takes up a lot of time that is unpaid. :money_with_wings:\n\nIf you are using this package in commercial project(s), please consider the idea to become a sponsor or donating once:\n\n- [GitHub Sponsor](https://github.com/sponsors/fabiocaccamo)\n- [PayPal](https://www.paypal.me/fabiocaccamo)\n- BTC: bc1q2t0pv8z3udpyuvfnx5kskhqdad4dcvtfuzmvjw\n- ETH: 0x8B55Fb7798b5A9F797A4455C00821B6e53daca74\n\n## See also\n\n- [`django-colorfield`](https://github.com/fabiocaccamo/django-colorfield) - simple color field for models with a nice color-picker in the admin. \ud83c\udfa8\n\n- [`django-extra-settings`](https://github.com/fabiocaccamo/django-extra-settings) - config and manage typed extra settings using just the django admin. \u2699\ufe0f\n\n- [`django-maintenance-mode`](https://github.com/fabiocaccamo/django-maintenance-mode) - shows a 503 error page when maintenance-mode is on. \ud83d\udea7 \ud83d\udee0\ufe0f\n\n- [`django-redirects`](https://github.com/fabiocaccamo/django-redirects) - redirects with full control. \u21aa\ufe0f\n\n- [`django-treenode`](https://github.com/fabiocaccamo/django-treenode) - probably the best abstract model / admin for your tree based stuff. \ud83c\udf33\n\n- [`python-benedict`](https://github.com/fabiocaccamo/python-benedict) - dict subclass with keylist/keypath support, I/O shortcuts (base64, csv, json, pickle, plist, query-string, toml, xml, yaml) and many utilities. \ud83d\udcd8\n\n- [`python-codicefiscale`](https://github.com/fabiocaccamo/python-codicefiscale) - encode/decode Italian fiscal codes - codifica/decodifica del Codice Fiscale. \ud83c\uddee\ud83c\uddf9 \ud83d\udcb3\n\n- [`python-fsutil`](https://github.com/fabiocaccamo/python-fsutil) - file-system utilities for lazy devs. \ud83e\udddf\u200d\u2642\ufe0f\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "django-admin-interface is a modern responsive flat admin interface customizable by the admin itself.",
    "version": "0.16.2",
    "split_keywords": [
        "django",
        "admin",
        "interface",
        "responsive",
        "flat",
        "theme",
        "custom",
        "ui"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "9efbfaa0f7212dca15bade4787c846f9",
                "sha256": "970d5a82ac41d724dddfe75605e959c48a9a56f16beaf378718154ac64793856"
            },
            "downloads": -1,
            "filename": "django_admin_interface-0.16.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9efbfaa0f7212dca15bade4787c846f9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 198911,
            "upload_time": "2021-04-23T13:01:01",
            "upload_time_iso_8601": "2021-04-23T13:01:01.071645Z",
            "url": "https://files.pythonhosted.org/packages/83/31/ba3e83ad302011420e0a8108f6db1538d51b73e896b20a184e0f842a0bd9/django_admin_interface-0.16.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a5a2e8e9e675ec172c7398a4b2cabae0",
                "sha256": "74ec6733bc4f020f844d247c781194c9ad08eac98cecf1fd1e25805665f0aabe"
            },
            "downloads": -1,
            "filename": "django-admin-interface-0.16.2.tar.gz",
            "has_sig": false,
            "md5_digest": "a5a2e8e9e675ec172c7398a4b2cabae0",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 164821,
            "upload_time": "2021-04-23T13:01:02",
            "upload_time_iso_8601": "2021-04-23T13:01:02.702324Z",
            "url": "https://files.pythonhosted.org/packages/69/46/1e9cdcea19d3542fd3f1ba17ca87821dadb66b033ef7cab03fadbc1c55ca/django-admin-interface-0.16.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-04-23 13:01:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "fabiocaccamo",
    "error": "Could not fetch GitHub repository",
    "lcname": "django-admin-interface"
}
        
Elapsed time: 0.30368s