Metadata-Version: 2.1
Name: flask-feature-flag
Version: 0.0.4
Summary: Flask feature flag
Home-page: https://gitlab.com/terminus-zinobe/flask-feature-flag
Author: Terminus
Author-email: jose.salas@zinobe.com
License: UNKNOWN
Description: # Flask feature flag
        
        Tool to activate and deactivate project functionalities
        
        [![pipeline status](https://gitlab.com/terminus-zinobe/flask-feature-flag/badges/master/pipeline.svg)](https://gitlab.com/terminus-zinobe/flask-feature-flag/-/commits/master) [![coverage report](https://gitlab.com/terminus-zinobe/flask-feature-flag/badges/master/coverage.svg)](https://gitlab.com/terminus-zinobe/flask-feature-flag/-/commits/master)
        
        ## Environment
        - Create
            ```shell
            $ python3 -m venv venv
            ```
        - Activate
            ```shell
            $ source venv/bin/activate
            ```
        - Deactivate
            ```shell
            $ deactivate
            ```
        
        ## Package installation
        - Installation
            ```shell
            $ pip3 install flask-feature-flag
            ```
        
        - You should add this to your `config.py`
            ```python
            FEATURE_FLAGS = {
                'ROUTE_ENABLED': os.environ.get('ROUTE_ENABLED', True)
            }
            ```
            `FEATURE_FLAGS` is  required
        
        ## Docs
        
        - [Flask-Feature-Flag’s documentation](https://flask-feature-flag-docs.readthedocs.io/en/latest/index.html)
        
        Example:
        
        `is_enabled` this decorator allows to activate or deactivate a functionality and receives as parameters a function to return in case feature is disabled and the name of the feature
        
            ```python
            from flask_feature_flag import is_enabled
        
            def error():
                return dict(massage='this is a mistake')
        
            @is_enabled(error, 'ENV_HELLO')
            def hello(name):
                return dict(message=f'Hi, {name}')
            ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
