https://github.com/alir3z4/django-crequest

django-crequest - Taking care of current request in silent way.
https://github.com/alir3z4/django-crequest

authentication django

Last synced: 19 days ago
JSON representation

django-crequest - Taking care of current request in silent way.

• Host: GitHub
• URL: https://github.com/alir3z4/django-crequest
• Owner: Alir3z4
• License: bsd-3-clause
• Created: 2012-05-23T13:41:13.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2018-05-11T09:38:09.000Z (almost 7 years ago)
• Last Synced: 2025-01-22T15:54:28.674Z (20 days ago)
• Topics: authentication, django
• Language: Python
• Homepage: http://pypi.python.org/pypi/django-crequest
• Size: 22.5 KB
• Stars: 60
• Watchers: 7
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: ChangeLog.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
===============

django-crequest

===============

.. contents:: 

Overview

========

- ``crequest`` takes care of current ``request`` in silent way.

- ``crequest`` will bring you current ``request`` object of your Django application from anywhere in your code.

Installing

==========

``django-crequest`` is available on http://pypi.python.org/pypi/django-crequest

So it can be installed it by pip::

    $ python pip install django-crequest

Or you can grab the latest version tarball and ::

    $ python setup.py install

To enable ``django-crequest`` in your project

* Add ``crequest`` to *INSTALLED_APPS* in your **settings.py**

* Add ``crequest.middleware.CrequestMiddleware`` to ``MIDDLEWARE_CLASSES`` after the authentication and session middleware.

Supported Python versions

=========================

``django-crequest`` currently can be run on multiple python versions:

* Python 2

* Python 3

* PyPy

How to use

==========

First import the crequest's middleware::

    from crequest.middleware import CrequestMiddleware

Get the current ``request`` ;)::

    current_request = CrequestMiddleware.get_request()

Done.

In depth & Complex details

==========================

Set the current request in UnKnown situations::

     CrequestMiddleware.set_request(request)

Return *iam_request* if there is no current request::

    CrequestMiddleware.get_request(iam_request)

And finally delete::

    CrequestMiddleware.del_request()

The middleware automatically sets/deletes the current request for HTTP requests.

For other uses (management commands, scripts), you will need to do this yourself.