Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mgrouchy/django-stronghold
Get inside your stronghold and make all your Django views default login_required
https://github.com/mgrouchy/django-stronghold
Last synced: 8 days ago
JSON representation
Get inside your stronghold and make all your Django views default login_required
- Host: GitHub
- URL: https://github.com/mgrouchy/django-stronghold
- Owner: mgrouchy
- License: mit
- Created: 2013-01-29T02:30:21.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2022-09-01T10:40:38.000Z (about 2 years ago)
- Last Synced: 2024-05-22T15:10:37.193Z (6 months ago)
- Language: Python
- Homepage: http://mikegrouchy.com/django-stronghold
- Size: 189 KB
- Stars: 391
- Watchers: 20
- Forks: 49
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- -awesome-django - django-stronghold - Makes all your Django views default login_required. (Third-Party Packages / Views)
- awesome-django - django-stronghold - Makes all your Django views default login_required. (Third-Party Packages / Views)
- starred-awesome - django-stronghold - Get inside your stronghold and make all your Django views default login_required (Python)
README
[](https://travis-ci.org/mgrouchy/django-stronghold)
# Stronghold
Get inside your stronghold and make all your Django views default login_required
Stronghold is a very small and easy to use django app that makes all your Django project default to require login for all of your views.
WARNING: still in development, so some of the DEFAULTS and such will be changing without notice.
## Installation
Install via pip.
```sh
pip install django-stronghold
```
Add stronghold to your INSTALLED_APPS in your Django settings file
```python
INSTALLED_APPS = (
#...
'stronghold',
)
```
Then add the stronghold middleware to your MIDDLEWARE_CLASSES in your Django settings file
```python
MIDDLEWARE_CLASSES = (
#...
'stronghold.middleware.LoginRequiredMiddleware',
)
```
## Usage
If you followed the installation instructions now all your views are defaulting to require a login.
To make a view public again you can use the public decorator provided in `stronghold.decorators` like so:
### For function based views
```python
from stronghold.decorators import public
@public
def someview(request):
# do some work
#...
```
### For class based views (decorator)
```python
from django.utils.decorators import method_decorator
from stronghold.decorators import public
class SomeView(View):
def get(self, request, *args, **kwargs):
# some view logic
#...
@method_decorator(public)
def dispatch(self, *args, **kwargs):
return super(SomeView, self).dispatch(*args, **kwargs)
```
### For class based views (mixin)
```python
from stronghold.views import StrongholdPublicMixin
class SomeView(StrongholdPublicMixin, View):
pass
```
## Configuration (optional)
### STRONGHOLD_DEFAULTS
Use Strongholds defaults in addition to your own settings.
**Default**:
```python
STRONGHOLD_DEFAULTS = True
```
You can add a tuple of url regexes in your settings file with the
`STRONGHOLD_PUBLIC_URLS` setting. Any url that matches against these patterns
will be made public without using the `@public` decorator.
### STRONGHOLD_PUBLIC_URLS
**Default**:
```python
STRONGHOLD_PUBLIC_URLS = ()
```
If STRONGHOLD_DEFAULTS is True STRONGHOLD_PUBLIC_URLS contains:
```python
(
r'^%s.+$' % settings.STATIC_URL,
r'^%s.+$' % settings.MEDIA_URL,
)
```
When settings.DEBUG = True. This is additive to your settings to support serving
Static files and media files from the development server. It does not replace any
settings you may have in `STRONGHOLD_PUBLIC_URLS`.
> Note: Public URL regexes are matched against [HttpRequest.path_info](https://docs.djangoproject.com/en/dev/ref/request-response/#django.http.HttpRequest.path_info).
### STRONGHOLD_PUBLIC_NAMED_URLS
You can add a tuple of url names in your settings file with the
`STRONGHOLD_PUBLIC_NAMED_URLS` setting. Names in this setting will be reversed using
`django.core.urlresolvers.reverse` and any url matching the output of the reverse
call will be made public without using the `@public` decorator:
**Default**:
```python
STRONGHOLD_PUBLIC_NAMED_URLS = ()
```
If STRONGHOLD_DEFAULTS is True additionally we search for `django.contrib.auth`
if it exists, we add the login and logout view names to `STRONGHOLD_PUBLIC_NAMED_URLS`
### STRONGHOLD_USER_TEST_FUNC
Optionally, set STRONGHOLD_USER_TEST_FUNC to a callable to limit access to users
that pass a custom test. The callback receives a `User` object and should
return `True` if the user is authorized. This is equivalent to decorating a
view with `user_passes_test`.
**Example**:
```python
STRONGHOLD_USER_TEST_FUNC = lambda user: user.is_staff
```
**Default**:
```python
STRONGHOLD_USER_TEST_FUNC = lambda user: user.is_authenticated
```
## Compatiblity
Tested with:
- Django 1.8.x
- Django 1.9.x
- Django 1.10.x
- Django 1.11.x
- Django 2.0.x
- Django 2.1.x
- Django 2.2.x
## Contribute
See CONTRIBUTING.md