Metadata-Version: 2.1
Name: django-spam
Version: 1.0.0
Summary: Redirecting bots to utilize their time better...
Home-page: http://github.com/Tivix/django-spam
Author: Nick Kelly
Author-email: nick.kelly@tivix.com
License: UNKNOWN
Description: django-spam
        ===========
        
        <p align="center">
        <a href="https://travis-ci.org/nickatnight/django-spam"><img alt="Build Status" src="https://travis-ci.org/nickatnight/django-spam.svg?branch=master"></a>
        <a href="https://coveralls.io/github/nickatnight/django-spam?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/nickatnight/django-spam/badge.svg?branch=master"></a>
        <a href="https://github.com/Tivix/django-spam/releases"><img alt="Release Status" src="https://img.shields.io/github/v/release/Tivix/django-spam"></a>
        </p>
        
        ![alt text](https://media.giphy.com/media/Mr8Gr9ejR0OpW/giphy.gif "django_spam")
        
        Inspired by this Nick Craver tweet https://twitter.com/nick_craver/status/720062942960623616
        
        We all hate bots, lets admit it. Especially the ones that try to gain access to our most secret endpoints. Well we have an easy
        solution for your django application. django_spam simply adds common admin urls to url conf so when bots (or human
        for that matter) try and access them, they will get redirected...
        
        
        |            | Django 2.0         | Django 2.1         | Django 2.2         | Django 3.0         | Django 3.1         |
        | --         | --                 | --                 | --                 | --                 | --                 |
        | Python 3.4 | :heavy_check_mark: |                    |                    |                    |                    |
        | Python 3.5 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |                    |                    |
        | Python 3.6 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
        | Python 3.7 | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
        | Python 3.8 |                    |                    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
        | Python 3.9 |                    |                    |                    | :heavy_check_mark: | :heavy_check_mark: |
        
        
        To install:
        ```python
        pip install django-spam
        ```
        
        Add to apps list:
        ```python
        INSTALLED_APPS = [
            '...',
            'django_spam',
            '...'
        ]
        ```
        
        django_spam ships with some default endpoints bots might try to hit. If you would like to add extra routes, simply add
        a ``SPAM_ROUTES`` variable to your settings file that contains a list of extra endpoints you would like
        to add. *no leading slashes*
        ```python
        SPAM_ROUTES = [
            'admin.php',
            'admin/login.php',
            'administrator/index.php',
            'index.php',
            '...',
        ]
        ```
        
        The same goes for ``SPAM_URLS`` you would like traffic to get forwarded to. Add some fun urls:
        
        ```python
        SPAM_URLS = [
            # 10 hours of Donald Trump saying bing bing bong
            'https://www.youtube.com/watch?v=UKbOqEk6rsk',
            # 10 hours of Darth Vader breathing
            'https://www.youtube.com/watch?v=un8FAjXWOBY',
            '...',
        ]
        ```
        
        Include ``django_spam.urls`` to root url file:
        ```python
        
        '...'
        url(r'', include('django_spam.urls')),  # for Django >= 2.0: path('', include('django_spam.urls')),
        '...',
        ```
        
        If for some odd reason you need to exclude routes, define ``EXCLUDED_ROUTES`` in settings. *no leading slashes*
        
        ```python
        EXCLUDED_ROUTES = [
            'admin.php',
            'index.php'
        ]
        ```
        
        @Tivix
Keywords: django spam
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.0
Classifier: Framework :: Django :: 2.1
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.0
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development
Description-Content-Type: text/markdown
