Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
katiam2 authored Nov 28, 2024
2 parents 4f14b71 + 59228af commit 7963485
Show file tree
Hide file tree
Showing 44 changed files with 246 additions and 190 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
name: Build
on:
push:
branches: [master]
branches: [main]
pull_request:
branches: [master]
branches: [main]

jobs:
build:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/pre-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
name: Deploy to test.pypi.org
on:
push:
branches: [master]
branches: [main]
pull_request:
branches: [master]
branches: [main]

# Only allow the latest workflow to run and cancel all others. There is also job-level concurrency
# enabled (see below), which is specified slightly differently.
Expand Down Expand Up @@ -78,11 +78,11 @@ jobs:
run: poetry config repositories.test_pypi https://test.pypi.org/legacy/

- name: Deploy to testpypi.org
if: github.ref == 'refs/heads/master'
if: github.ref == 'refs/heads/main'
run: poetry publish -r test_pypi --dist-dir dist/ --username __token__ --password ${{ secrets.TEST_PYPI_TOKEN }} || true

- name: Deploy to testpypi.org (Dry Run)
if: github.ref != 'refs/heads/master'
if: github.ref != 'refs/heads/main'
run: poetry publish -r test_pypi --dist-dir dist/ --username __token__ --password ${{ secrets.TEST_PYPI_TOKEN }} || true

update_release_draft:
Expand All @@ -91,7 +91,7 @@ jobs:
pull-requests: read
runs-on: ubuntu-latest
needs: deploy
if: github.ref == 'refs/heads/master'
if: github.ref == 'refs/heads/main'
steps:
- uses: release-drafter/release-drafter@v5
with:
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ them as quickly as I would like, but im trying to get through them all now, hope
[![PyPI version](https://badge.fury.io/py/django-jazzmin.svg)](https://pypi.python.org/pypi/django-jazzmin/)
![Python versions](https://img.shields.io/badge/python-%3E=3.8-brightgreen)
![Django Versions](https://img.shields.io/badge/django-%3E=4.2-brightgreen)
[![Coverage Status](https://coveralls.io/repos/github/farridav/django-jazzmin/badge.svg?branch=master)](https://coveralls.io/github/farridav/django-jazzmin?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/farridav/django-jazzmin/badge.svg?branch=main)](https://coveralls.io/github/farridav/django-jazzmin?branch=main)

Drop-in theme for django admin, that utilises AdminLTE 3 & Bootstrap 4 to make yo' admin look jazzy
Drop-in theme for django admin, that utilises AdminLTE 3.2 & Bootstrap 5 to make yo' admin look jazzy

## Installation

Expand All @@ -33,7 +33,7 @@ pip install django-jazzmin

## Documentation

See [Documentation](https://django-jazzmin.readthedocs.io) or [Test App](https://github.com/farridav/django-jazzmin/tree/master/tests/test_app/library/settings.py)
See [Documentation](https://django-jazzmin.readthedocs.io) or [Test App](https://github.com/farridav/django-jazzmin/tree/main/tests/test_app/library/settings.py)

## Features

Expand All @@ -42,12 +42,12 @@ See [Documentation](https://django-jazzmin.readthedocs.io) or [Test App](https:/
- Customisable top menu
- Customisable user menu
- 4 different Change form templates (horizontal tabs, vertical tabs, carousel, collapsible)
- Bootstrap 4 modal (instead of the old popup window, optional)
- Bootstrap 5 modal (instead of the old popup window, optional)
- Search bar for any given model admin
- Customisable UI (via Live UI changes, or custom CSS/JS)
- Responsive
- Select2 drop-downs
- Bootstrap 4 & AdminLTE UI components
- Bootstrap 5 & AdminLTE UI components
- Using the latest [adminlte](https://adminlte.io/) + [bootstrap](https://getbootstrap.com/)

## Screenshots
Expand Down Expand Up @@ -120,8 +120,8 @@ This was initially a Fork of <https://github.com/wuyue92tree/django-adminlte-ui>
deserved its own package, big thanks to @wuyue92tree for all of his initial hard work, we are still patching into that
project were possible, but this project has taken a different direction.

The javascript modal implementation uses some code from [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface/blob/master/admin_interface/static/admin/js/popup_response.js), so thanks to @fabiocaccamo for original work
The javascript modal implementation uses some code from [django-admin-interface](https://github.com/fabiocaccamo/django-admin-interface/blob/main/admin_interface/static/admin/js/popup_response.js), so thanks to @fabiocaccamo for original work

- Based on AdminLTE 3: <https://adminlte.io/>
- Using Bootstrap 4: <https://getbootstrap.com/>
- Using Bootstrap 5: <https://getbootstrap.com/>
- Using Font Awesome 5: <https://fontawesome.com/>
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Namely:
- `LOCALE_DIRS` is setup
- `LANGUAGES` have been defined

See our [test app settings](https://github.com/farridav/django-jazzmin/tree/master/tests/test_app/library/settings.py)
See our [test app settings](https://github.com/farridav/django-jazzmin/tree/main/tests/test_app/library/settings.py)
for a practical example.

![Language chooser](./img/language_chooser.png)
Expand All @@ -367,7 +367,7 @@ defaults to `False`
### Adding extra actions to model's form view

Add a template for your model on your main template directory,
e.g [app/templates/admin/app_name/model_name/submit_line.html](https://github.com/farridav/django-jazzmin/tree/master/tests/test_app/library/books/templates/admin/loans/bookloan/submit_line.html)
e.g [app/templates/admin/app_name/model_name/submit_line.html](https://github.com/farridav/django-jazzmin/tree/main/tests/test_app/library/books/templates/admin/loans/bookloan/submit_line.html)

```djangotemplate
{# extends "admin/submit_line.html" #}
Expand Down
8 changes: 4 additions & 4 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Run development server (with werkzeug debugger)

## Running the tests

Tests are run via github actions on any pull request into `master`, and are written for use with the [pytest](https://docs.pytest.org/en/latest/)
Tests are run via github actions on any pull request into `main`, and are written for use with the [pytest](https://docs.pytest.org/en/latest/)
framework, we should have good enough tests for you to base your own off of, though where we are lacking, feel free to contribute,
but keep it clean, concise and simple, leave the magic to the wizards.

Expand All @@ -39,7 +39,7 @@ Run against all supported Python and Django Versions using `tox`
## Contribution guidelines

- Fork the project
- Make a pull request against this repositories `master` branch,
- Make a pull request against this repositories `main` branch,
- Include tests unless its a trivial change
- Add a screenshot if your proposing UI changes
- Demonstrate the change within the `test_app` if possible
Expand Down Expand Up @@ -71,7 +71,7 @@ or use a string that is already translated upstream in Django.
4. cd ../
5. Run ./cli.py locales --prune de to remove the django provided strings
6. Go through the strings in the locale file, any that are not genuinely new strings introduced by jazzmin, find them in the codebase, and try making them match the ones provided in djangos admin/admin docs translation files
- [Django admin translations](https://raw.githubusercontent.com/django/django/master/django/contrib/admindocs/locale/)
- [Django admin docs translations](https://raw.githubusercontent.com/django/django/master/django/contrib/admin/locale/de/LC_MESSAGES/django.po)
- [Django admin translations](https://raw.githubusercontent.com/django/django/main/django/contrib/admindocs/locale/)
- [Django admin docs translations](https://raw.githubusercontent.com/django/django/main/django/contrib/admin/locale/de/LC_MESSAGES/django.po)

Once you have finished, run `makemessages` again, until the file contains ONLY unique strings to jazzmin, there should only be a handful
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ customise, including a built-in UI customizer

- Drop-in admin skin, all configuration optional
- Select2 drop-downs
- Bootstrap 4 & AdminLTE UI components
- Bootstrap 5 & AdminLTE UI components
- Search bar for any given model admin
- Modal windows instead of popups
- Customisable side menu
Expand Down Expand Up @@ -77,5 +77,5 @@ deserved its own package, big thanks to @wuyue92tree for all of his initial hard
project were possible, but this project is taking a slightly different direction.

- Based on AdminLTE 3: <https://adminlte.io/>
- Using Bootstrap 4: <https://getbootstrap.com/>
- Using Bootstrap 5: <https://getbootstrap.com/>
- Using Font Awesome 5: <https://fontawesome.com/>
4 changes: 4 additions & 0 deletions jazzmin/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,7 @@
"lumen": "vendor/bootswatch/lumen/bootstrap.min.css",
"lux": "vendor/bootswatch/lux/bootstrap.min.css",
"materia": "vendor/bootswatch/materia/bootstrap.min.css",
"morph": "vendor/bootswatch/morph/bootstrap.min.css",
"minty": "vendor/bootswatch/minty/bootstrap.min.css",
"pulse": "vendor/bootswatch/pulse/bootstrap.min.css",
"sandstone": "vendor/bootswatch/sandstone/bootstrap.min.css",
Expand All @@ -178,12 +179,15 @@
"spacelab": "vendor/bootswatch/spacelab/bootstrap.min.css",
"united": "vendor/bootswatch/united/bootstrap.min.css",
"yeti": "vendor/bootswatch/yeti/bootstrap.min.css",
"quartz": "vendor/bootswatch/quartz/bootstrap.min.css",
"zephyr": "vendor/bootswatch/zephyr/bootstrap.min.css",
# dark themes
"darkly": "vendor/bootswatch/darkly/bootstrap.min.css",
"cyborg": "vendor/bootswatch/cyborg/bootstrap.min.css",
"slate": "vendor/bootswatch/slate/bootstrap.min.css",
"solar": "vendor/bootswatch/solar/bootstrap.min.css",
"superhero": "vendor/bootswatch/superhero/bootstrap.min.css",
"vapor": "vendor/bootswatch/vapor/bootstrap.min.css",
}

DARK_THEMES = ("darkly", "cyborg", "slate", "solar", "superhero")
Expand Down
6 changes: 3 additions & 3 deletions jazzmin/static/vendor/adminlte/css/adminlte.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion jazzmin/static/vendor/adminlte/css/adminlte.min.css.map

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions jazzmin/static/vendor/adminlte/js/adminlte.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion jazzmin/static/vendor/adminlte/js/adminlte.min.js.map

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions jazzmin/static/vendor/bootstrap/js/bootstrap.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion jazzmin/static/vendor/bootstrap/js/bootstrap.min.js.map

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/cerulean/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/cosmo/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/cyborg/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/darkly/bootstrap.min.css

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions jazzmin/static/vendor/bootswatch/default/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/flatly/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/journal/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/litera/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/lumen/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/lux/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/materia/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/minty/bootstrap.min.css

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions jazzmin/static/vendor/bootswatch/morph/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/pulse/bootstrap.min.css

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions jazzmin/static/vendor/bootswatch/quartz/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/sandstone/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/simplex/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/sketchy/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/slate/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/solar/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/spacelab/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/superhero/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/united/bootstrap.min.css

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions jazzmin/static/vendor/bootswatch/vapor/bootstrap.min.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions jazzmin/static/vendor/bootswatch/yeti/bootstrap.min.css

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions jazzmin/static/vendor/bootswatch/zephyr/bootstrap.min.css

Large diffs are not rendered by default.

Loading

0 comments on commit 7963485

Please sign in to comment.