Metadata-Version: 2.1
Name: blacksheep-messages
Version: 1.0.1
Summary: Extension for BlackSheep that similiar with flask flashes messages
Home-page: https://github.com/riordanz/BlackSheep-Messages
Author: Riordan Ganezo
Author-email: black.ganezo@gmail.com
License: MIT
Description: # BlackSheep-Messages
        Extension for [BlackSheep](https://github.com/Neoteroi/BlackSheep) that similar with flask flashes message
        
        ```bash
        pip install blacksheep-sqlalchemy
        ```
        
        ## How to use (BlackSheep MVC)
        
        First, set your web_url on settings.yaml
        
        ```yaml
        app_name: Your Website
        web_url: http://localhost:8000
        ```
        
        Then, you can import BlackSheep Messages on server.py
        
        ```python
        from app.configuration import load_configuration
        from app.program import configure_application
        from app.services import configure_services
        from blacksheep_messages import use_blacksheep_message
        
        if uvloop is not ...:
            uvloop.install()
        
        app = configure_application(*configure_services(load_configuration()))
        use_blacksheep_message(app, load_configuration())
        
        ```
        
        After registering BlackSheep Messages, services are configured in the application, so they are automatically resolved in any request handler requiring a parameter named bs_message
        
        ```python
        
        @post("/register")
        async def register_action(bs_message):
            if True:
                bs_message.add("No Error", "success")
            else:
                bs_message.add("Error found", "error")
        
        ```
        
        Than you can get message using `bs_message(category)` on jinja2 template
        
        ```jinja2
        {% if bs_message("success", check=True) %}
        	{% for msg in bs_message("success") %}
        		{{ msg }}
        	{% endfor %}
        {% endif %}
        
        {% if bs_message("error", check=True) %}
        	{% for msg in bs_message("error") %}
        		{{ msg }}
        	{% endfor %}
        {% endif %}
        ```
        
        Note : set check value to True to avoid message deleted automatically.
        =======
        # BlackSheep-Messages
        Extension for BlackSheep that similiar with flask flashes messages
        >>>>>>> d6ed37df41252e9d131920da2f3b133417ae4f76
        
Keywords: blacksheep flask flashes message messages
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
