Metadata-Version: 2.1
Name: Flask-Discussion
Version: 0.1.0
Summary: Comment system integration for Flask applications
Home-page: https://github.com/rmed/flask-discussion
Author: Rafael Medina García
Author-email: rafamedgar@gmail.com
License: MIT
Description: # Flask-Discussion
        
        [![Documentation Status](https://readthedocs.org/projects/flask-discussion/badge/?version=latest)](https://flask-discussion.readthedocs.io/en/latest/?badge=latest)
        
        
        Flask-Discussion is an extension for
        [Flask](https://palletsprojects.com/p/flask/) that adds support for several
        discussion/comment systems to your application.
        
        Supported comment systems:
        
        - [Disqus](https://disqus.com)
        - [Isso](https://github.com/posativ/isso/)
        
        
        ## Quickstart
        
        First install the extension:
        
        ```
        pip install Flask-Discussion
        ```
        
        And then initialize it in your application:
        
        ```python
        from flask import Flask
        from flask_discussion import Discussion
        
        discussion = Discussion()
        
        def init_app():
            app = Flask(__name__)
        
            # Set config values
            # .....
        
            discussion.init_app(app)
        ```
        
        This will register the extension templates (which contain the macros for each
        comment system) with your application, making them available in your own
        templates.
        
        If you want to be able to swap comment systems through the configuration of
        your application, you may use the macro defined in
        `flask_discussion/helper.html`:
        
        ```django
        {% import "flask_discussion/helper.html" as discussion %}
        
        <html>
            <body>
                {{ discussion.render_comments(title="Page title", identifier="my-page", url="http://mypage.com") }}
            </body>
        </html>
        ```
        
        Note that the macro **receives any keyword argument and will relay the
        appropriate information to the corresponding system-specific macro** (i.e. each
        comment system may use only specific information, therefore you should provide
        all possible values for all comment systems).
        
        However, if you only want to use a specific comment system, you may import its
        macros directly. For instance, for Disqus:
        
        ```django
        {% import "flask_discussion/disqus.html" as disqus %}
        
        <html>
            <body>
                {{ disqus.render_comments(identifier="my-page", url="http://mypage.com", title="Page title") }}
            </body>
        </html>
        ```
        
        ## Documentation
        
        Documentation is available at <https://flask-discussion.readthedocs.io>.
        
Keywords: flask discussion comments commenting
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Flask
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown
