OpenWISP 2 Utilities
Project description
Python and Django utilities shared between different OpenWISP modules.
Current features
Customized admin theme for OpenWISP modules
Multitenant admin interface and testing mixins
TimeStamped models and mixins which add self-updating created and modified fields.
DependencyLoader: template loader which looks in the templates dir of all django-apps listed in EXTENDED_APPS
DependencyFinder: finds static files of django-apps listed in EXTENDED_APPS
Project goals
Minimize code duplication among OpenWISP modules
Install stable version from pypi
Install from pypi:
pip install openwisp-utils
# install optional dependencies for openwisp-users too
pip install openwisp-utils[users]Install development version
Install tarball:
pip install https://github.com/openwisp/openwisp-utils/tarball/masterAlternatively you can install via pip using git:
pip install -e git+git://github.com/openwisp/openwisp-utils#egg=openwisp-utilsIf you want to contribute, install your cloned fork:
git clone git@github.com:<your_fork>/openwisp-utils.git
cd openwisp-utils
python setup.py developUsing the utilities in OpenWISP modules
INSTALLED_APPS in settings.py should look like the following if you want to use all the utilities
INSTALLED_APPS = [
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
# customized admin theme
'openwisp_utils.admin_theme',
# all-auth
'django.contrib.sites',
'allauth',
'allauth.account',
'allauth.socialaccount',
'django_extensions',
# openwisp2 modules
'openwisp_users',
# admin
'django.contrib.admin',
]Using the admin_theme
For using the customized admin theme,
Make sure you’ve added openwisp_utils.admin_theme to INSTALLED_APPS in settings.py
Add the following into your urls.py file which contains admin urls.
from django.conf.urls import include, url
from openwisp_utils.admin_theme.admin import admin, openwisp_admin
openwisp_admin()
urlpatterns = [
# other url patterns
url(r'^admin/', include(admin.site.urls)),
]Admin mixins
These are mixins which make a ModelAdmin class multitenant: users will see only the objects related to the organizations they are associated with.
MultitenantAdminMixin: adding this mixin to a ModelAdmin class will make it multitenant. Set multitenant_shared_relations to the list of parameters you wish to have only organization specific options.
MultitenantOrgFilter: admin filter that shows only organizations the current user is associated with in its available choices.
MultitenantRelatedOrgFilter: similar MultitenantOrgFilter but shows only objects which have a relation with one of the organizations the current user is associated with.
TimeReadonlyAdminMixin: Admin mixin which adds two readonly fields created and modified. This is an admin mixin for models inheriting TimeStampedEditableModel which adds the fields created and modified to the database.
Example usage:
from django.contrib import admin
from openwisp_utils.admin import (MultitenantAdminMixin,
MultitenantObjectFilter,
MultitenantOrgFilter,
TimeReadonlyAdminMixin)
from .models import Book, Shelf
class BaseAdmin(MultitenantAdminMixin, TimeReadonlyAdminMixin, admin.ModelAdmin):
pass
class ShelfAdmin(BaseAdmin):
list_display = ['name', 'organization']
list_filter = [('organization', MultitenantOrgFilter)]
fields = ['name', 'organization', 'created', 'modified']
class BookAdmin(BaseAdmin):
list_display = ['name', 'author', 'organization', 'shelf']
list_filter = [('organization', MultitenantOrgFilter),
('shelf', MultitenantObjectFilter)]
fields = ['name', 'author', 'organization', 'shelf', 'created', 'modified']
multitenant_shared_relations = ['shelf']Using DependencyLoader and DependencyFinder
Add the list of all packages extended to EXTENDED_APPS in settings.py. If you’ve extended django_netjsonconfig and django_x509:
EXTENDED_APPS = ['django_netjsonconfig', 'django_x509']DependencyFinder
Add openwisp_utils.staticfiles.DependencyFinder to STATICFILES_FINDERS in settings.py.
STATICFILES_FINDERS = [
'django.contrib.staticfiles.finders.FileSystemFinder',
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
'openwisp_utils.staticfiles.DependencyFinder',
]DependencyLoader
Add openwisp_utils.staticfiles.DependencyFinder to TEMPLATES_LOADERS in settings.py or as shown below.
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'OPTIONS': {
'loaders': [
'django.template.loaders.filesystem.Loader',
'django.template.loaders.app_directories.Loader',
'openwisp_utils.loaders.DependencyLoader',
],
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]Installing for development
Install sqlite:
sudo apt-get install sqlite3 libsqlite3-devInstall your forked repo:
git clone git://github.com/<your_fork>/openwisp-utils
cd openwisp-utils/
python setup.py developInstall test requirements:
pip install -r requirements-test.txtCreate database:
cd tests/
./manage.py migrate
./manage.py createsuperuserSet EMAIL_PORT in settings.py to a port number (eg: 1025):
EMAIL_PORT = '1025'Launch development server and SMTP deubgging server:
./manage.py runserver
# open another session and run
python -m smtpd -n -c DebuggingServer localhost:1025You can access the admin interface of the test project at http://127.0.0.1:8000/admin/.
Run tests with:
./runtests.pyContributing
Announce your intentions in the OpenWISP Mailing List and open relavant issues using the issue tracker
Fork this repo and install the project following the instructions
Write code and corresponding tests
Ensure that all tests pass and the test coverage does not decrease
Document your changes
Send a pull request
Changelog
See CHANGES.
License
See LICENSE.
Support
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.
Source Distribution
Built Distribution
File details
Details for the file openwisp-utils-0.1.2.tar.gz.
File metadata
- Download URL: openwisp-utils-0.1.2.tar.gz
- Upload date:
- Size: 53.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 18b158196abafe11321eb965ee476885d5ac7eecff5aa1b2e4e628defb387f21 |
|
| MD5 | f9b74dce0c8a2552d48f0edb6282bd8e |
|
| BLAKE2b-256 | 304e1b1af60bd2b56dfb732e9e8b6d78012080d4f2f636e7386ef7326938045d |
File details
Details for the file openwisp_utils-0.1.2-py2.py3-none-any.whl.
File metadata
- Download URL: openwisp_utils-0.1.2-py2.py3-none-any.whl
- Upload date:
- Size: 58.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ff29db23d523cf068a955ba3e61d9254ad735a89541a17d97bfbcdb157ef375e |
|
| MD5 | 05551a0a2d2083015b1aec000295e7ec |
|
| BLAKE2b-256 | 8634a2fbb1d84707a5b2024276eeb38a34bfa37e744e76ac1b71eed407762352 |
