https://github.com/julianwachholz/django-guest-user

A Django app that allows visitors to interact with your site as a guest user without requiring registration.
https://github.com/julianwachholz/django-guest-user

django django-allauth django-registration python3

Last synced: 12 days ago
JSON representation

A Django app that allows visitors to interact with your site as a guest user without requiring registration.

• Host: GitHub
• URL: https://github.com/julianwachholz/django-guest-user
• Owner: julianwachholz
• License: mit
• Created: 2021-10-23T21:55:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-27T16:26:05.000Z (10 months ago)
• Last Synced: 2024-10-18T06:14:24.148Z (21 days ago)
• Topics: django, django-allauth, django-registration, python3
• Language: Python
• Homepage: https://django-guest-user.readthedocs.io/
• Size: 117 KB
• Stars: 74
• Watchers: 4
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-django - django-guest-user - Allow visitors to use your site like a regular user and register later. (Third-Party Packages / Users)

README

        
[![Code Lint](https://github.com/julianwachholz/django-guest-user/actions/workflows/lint.yml/badge.svg)](https://github.com/julianwachholz/django-guest-user/actions/workflows/lint.yml)

[![Python Tests](https://github.com/julianwachholz/django-guest-user/actions/workflows/test.yml/badge.svg)](https://github.com/julianwachholz/django-guest-user/actions/workflows/test.yml)

[![Documentation](https://readthedocs.org/projects/django-guest-user/badge/?style=flat)](https://django-guest-user.readthedocs.io)

# django-guest-user

Allow visitors to interact with your site like a temporary user ("guest")

without requiring registration.

Anonymous visitors who request a decorated page get a real temporary user object

assigned and are logged in automatically. They can use the site like a normal

user until they decide to convert to a real user account to save their data.

Inspired by and as an alternative for [django-lazysignup](https://github.com/danfairs/django-lazysignup)

and rewritten for Django 3.2+ and Python 3.8+.

## Documentation

Find the [**complete documentation**](https://django-guest-user.readthedocs.io/)

on Read the Docs.

## Quickstart

1. Install the `django-guest-user` package from PyPI

2. Add `guest_user` to your `INSTALLED_APPS` and migrate your database

3. Add `guest_user.backends.GuestBackend` to your `AUTHENTICATION_BACKENDS`

4. Include `guest_user.urls` in your URLs

5. Decorate your views with `@allow_guest_user`:

   ```python

   from guest_user.decorators import allow_guest_user

   @allow_guest_user

   def my_view(request):

       assert request.user.is_authenticated

       return render(request, "my_view.html")

   ```

A more detailed guide is available in the

[installation documentation](https://django-guest-user.readthedocs.io/en/latest/setup.html#how-to-install).

## Contributing

All contributions are welcome! Please read the

[contributing guidelines](CONTRIBUTING.md) in this repostory.

## Development Status

This project is under active development. Thanks to

[previous work](https://github.com/danfairs/django-lazysignup) the core

functionality is well-established and this package builds on top of it.

This project was created because the original project has been in an inactive

state without major updates in a long time. The code base was rewritten with

only modern versions of Python and Django in mind.