Metadata-Version: 1.1
Name: permalink_adder
Version: 0.1.4.1
Summary: SEO tool for adding permalinks to text contained in Django apps databases.
Home-page: https://github.com/plizonczyk/permalink_adder
Author: Piotr Lizończyk
Author-email: piotr.lizonczyk@gmail.com
License: UNKNOWN
Download-URL: https://github.com/plizonczyk/p`ermalink_adder/tarball/0.1
Description: permalink\_adder
        ================
        
        SEO tool for adding permalinks to text contained in Django apps
        databases.
        
        Installation
        ============
        
        Install with pip:
        
        ::
        
            pip install permalink_adder
        
        Usage
        =====
        
        You need to specify where and what to look for in you django settings
        app in this manner:
        
        ::
        
            PERMALINK_ADDER_SETTINGS = [{'app': 'your_app_name',
                                        'model_name': 'your_model_name',
                                        'fields': ['list', 'of', 'fields', 'in', 'which', 'script', 'should', 'search'],
                                        'words': ['list', 'of', 'words', 'to', 'search'],
                                        'url': 'url_that_should_be_wrapped_around_found_text',
                                        'dry_run': True}]
        
        Setting ``dry_run`` to ``False`` will actually apply changes to
        database, instead of printing them out.
        
        You can run the script either using ``add_permalinks`` management
        command or call ``permalink_adder`` function from ``adder.py`` module.
        
        Output
        ======
        
        No output if there are no occurrences of words or when they're already
        wrapped.
        
        With ``dry_run`` set as ``True``, the script will print out proposed
        changes, setting it to ``False`` will only show context of applied
        changes.
        
Keywords: SEO,permalinks
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Framework :: Django
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Requires: django
