Metadata-Version: 2.1
Name: config-client
Version: 0.2.1
Summary: config service client
Home-page: https://github.com/amenezes/config-client
Author: alexandre menezes
Author-email: alexandre.fmenezes@gmail.com
License: Apache-2.0
Project-URL: Documentation, https://github.com/amenezes/config-client
Project-URL: Code, https://github.com/amenezes/config-client
Project-URL: Issue tracker, https://github.com/amenezes/config-client/issues
Description: [![Build Status](https://travis-ci.org/amenezes/config-client.svg?branch=master)](https://travis-ci.org/amenezes/config-client)
        [![Maintainability](https://api.codeclimate.com/v1/badges/7b8b70e0c20c6809df54/maintainability)](https://codeclimate.com/github/amenezes/config-client/maintainability)
        [![codecov](https://codecov.io/gh/amenezes/config-client/branch/master/graph/badge.svg)](https://codecov.io/gh/amenezes/config-client)
        [![PyPI version](https://badge.fury.io/py/config-client.svg)](https://badge.fury.io/py/config-client)
        
        # config-client
        
        config-client package for [spring cloud config](https://spring.io/projects/spring-cloud-config).
        
        ## Installing
        
        Install and update using pip:
        
        ````bash
        pip install -U config-client
        ````
        
        ## Dependencies
        
        - [requests](https://pypi.org/project/requests/)
        
        ## Setup
        
        config server url pattern:
        - http://<*config_server*>:<*config_server_port*>/configuration/<*branch*>/<*app_name*>-<*profile*>.json
        
        ````ini
        # expected environment variables:
        #
        CONFIGSERVER_ADDRESS=http://configserver:8888/configuration
        BRANCH=master
        PROFILE=development
        APP_NAME=myapp
        ````
        
        will result in:
        
        ````txt
        http://configserver:8888/configuration/master/myapp-development.json
        ````
        
        ### Default values
        
        if no value was adjusted for the environment variables below, the default value will be assumed, as:
        
        ````ini
        CONFIGSERVER_ADDRESS=http://localhost:8888/configuration
        BRANCH=master
        PROFILE=development
        APP_NAME=
        ````
        
        
        ## Usage Example
        
        ### using standard client
        
        ````python
        from config.spring import ConfigServer
        
        config_client = ConfigServer()
        config_client.config['spring']['cloud']['consul']['host']
        config_client.config.get('spring').get('cloud').get('consul').get('port')
        ````
        
        ### standard client with @decorator
        
        ````python
        from config import spring
        
        @spring.config_client
        def my_test(config_client):
        config_client.config['spring']['cloud']['consul']['host']
        config_client.config.get('spring').get('cloud').get('consul').get('port')
        ````
        
        Integration with Flask.
        
        ````python
        from config.spring import ConfigServer
        from flask import Flask
        
        
        config_client = ConfigServer()
        app = Flask(__name__)
        app.run(host='0.0.0.0',
                port=config_client.config['app']['port']
        ````
        
        ### using asyncio
        
        client using asyncio
        
        ````python
        import asyncio
        from config.spring import ConfigServer
        
        
        loop = asyncio.get_event_loop()
        config_client = ConfigServer()
        
        async def service_discovery():
            await discovery_client.register(config_client.config['app']['name'],
                                            config_client.config.get('app').get('port'))
        
        discovery_client = Consul(config_client.config['spring']['cloud']['consul']['host'],
                                  config_client.config['spring']['cloud']['consul']['port'],
                                  loop)
        loop.run_until_complete(service_discovery)
        ````
        
        ## Links
        
        - License: [Apache License](https://choosealicense.com/licenses/apache-2.0/)
        - Code: https://github.com/amenezes/config-client
        - Issue tracker: https://github.com/amenezes/config-client/issues
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Framework :: AsyncIO
Classifier: Framework :: Flask
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
