https://github.com/dhyanipalan/url_obfuscated

Easy and Simple method to obfuscate and deobfuscate your Django URLs. Works with both normal urls as well as those with params
https://github.com/dhyanipalan/url_obfuscated

django django-application obfuscated obfuscation python url-obfuscator urls

Last synced: 4 months ago
JSON representation

Easy and Simple method to obfuscate and deobfuscate your Django URLs. Works with both normal urls as well as those with params

• Host: GitHub
• URL: https://github.com/dhyanipalan/url_obfuscated
• Owner: dhyanipalan
• License: apache-2.0
• Created: 2023-03-16T10:16:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-13T17:45:18.000Z (about 3 years ago)
• Last Synced: 2025-09-01T12:50:29.381Z (10 months ago)
• Topics: django, django-application, obfuscated, obfuscation, python, url-obfuscator, urls
• Language: Python
• Homepage: https://pypi.org/project/url-obfuscated/
• Size: 17.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# url_obfuscated

Easy and Simple method to obfuscate and deobfuscate your Django URLs.

Works with both normal urls as well as those with params

## Quick start

Install using pip or easy_install

    $ pip install url-obfuscated

    $ easy_install url-obfuscated

Add "url_obfuscate" to your INSTALLED_APPS setting like this:

    INSTALLED_APPS = (

        ...

        'url-obfuscated',

    )

## Usage

To obfuscate Django's URLs, modify the URL declaration in the urls.py file by replacing the regex definition with the funcion generate_url_pattern, as follows:

    from url_obfuscated.helpers import generate_url_pattern

    .....

    urlpatterns = [

        url(generate_url_pattern('/'), home, name='home'),

        url(generate_url_pattern('obfuscated_link', params=['(?P[^/]+)']), obfuscated_link, name='obfuscated_link'),

        url(generate_url_pattern('optional_param', params=['(?:(?P[^/]+)/)?']), optional_param, name='optional_param'),

    ]

For the home URL, use / path. To include params in the URL, declare them in the desired order inside the params attribute. When obfuscating a URL with parameters, it is necessary to use the deobfuscate decorator to recover the original value of the parameter.

    from url_obfuscated.decorators import deobfuscate

    ...

    @deobfuscate

    def obfuscated_link(request, name):

        return render(request, 'obfuscate_result.html', { 'name': name })

When declaring URLs with parameters inside templates, use the obfuscate template tag, as follows:

    {% load obfuscate_tags %}

    ...

    
Obfuscated link: {% url 'obfuscated_link' 'Dan'|obfuscate %}

    ...


You can also obfuscate any value from inside a view, use the obfuscate function, as follows:

    from url_obfuscated.helpers import obfuscate

    ...

    def home(request):

        links = list()

        for i in range(10):

            links.append(obfuscate('Name %d' % (i+1)))

        return render(request, 'index.html', { 'links': links })