A role based admin UI for Django that produces a user friendly and beautiful UI.
Project description
Django cradmin
Django custom role based admin UI.
Django cradmin is in BETA. The system is fairly stable, but:
- We do not have getting started guides.
- We should have better tests before release. Some parts have been prototyped a lot while we tested out different concepts, and they need a complexity review and better tests.
- Works with Django 4 and python >=3.8,<3.11
Develop
Requires:
Use conventional commits for GIT commit messages
See https://www.conventionalcommits.org/en/v1.0.0/. You can use this git commit message format in many different ways, but the easiest is:
- Use commitizen: https://commitizen-tools.github.io/commitizen/commit/
- Use an editor extension, like https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits for VScode.
- Just learn to write the format by hand (can be error prone to begin with, but it is fairly easy to learn).
Install hatch and commitizen
NOTE: You only need hatch if you need to build releases, and you only need commitizen for releases OR to make it easy to follow conventional commits for your commit messages (see Use conventional commits for GIT commit messages above).
First install pipx with:
$ brew install pipx
$ pipx ensurepath
Then install hatch and commitizen:
$ pipx install hatch
$ pipx install commitizen
See https://github.com/pypa/pipx, https://hatch.pypa.io/latest/install/ and https://commitizen-tools.github.io/commitizen/ for more install alternatives if needed, but we really recommend using pipx since that is isolated.
Install development dependencies
Install a local python version with pyenv:
$ pyenv install 3.10
$ pyenv local 3.10
Install dependencies in a virtualenv:
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install ".[dev,test]"
Run dev server
$ source .venv/bin/activate # enable virtualenv
$ ievv devrun
Run tests
$ source .venv/bin/activate # enable virtualenv
$ pytest
Docs
http://django-cradmin.readthedocs.org
License
3-clause BSD license. See the LICENSE file in the same directory as this readme file.
How to release django_cradmin
Remember to run
$ ievv buildstatic
Release (create changelog, increment version, commit and tag the change) with:
$ cz bump
$ git push && git push --tags
NOTE:
cz bumponly works if conventional commits (see section about that above) is used.cz bumpcan take a specific version etc, but it automatically select the correct version if conventional commits has been used correctly. See https://commitizen-tools.github.io/commitizen/.- The
czcommand comes fromcommitizen(install documented above).
Release to pypi:
$ hatch build -t sdist
$ hatch publish
$ rm dist/* # optional cleanup
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
