Metadata-Version: 2.1
Name: ifconf
Version: 0.0.14
Summary: Integrated Framework for Configuration
Home-page: https://github.com/iflb/ifconf
Author: teppei@iflab.tokyo
Author-email: teppei@iflab.tokyo
License: UNKNOWN
Project-URL: Project Owner, http://www.pcl.cs.waseda.ac.jp/
Project-URL: Funding, https://www.waseda.jp/inst/gcs/news/2019/11/29/870/
Keywords: configuration argparse configparser logging
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: configparser

# Integrated Framework for Configuration

Alternative configuration framework using argparse and configparser.
Designed for the following purposes.

* Integration of command line args and configuration files
* Generation of default configuration files
* Class initialization procedure using parameter object pattern

## SAMPLE

* main.py 

        from ifconf import configure_main
        if __name__ == "__main__":
                configure_main()

* server.py

        from ifconf import configure_module, config_callback

        @config_callback
        def conf(loader):
            loader.add_attr('server_addr', '0.0.0.0', help='server inet addr to bind')
                loader.add_attr_int('server_port', 8080, help='server inet port to bind')
                loader.add_attr_boolean('udp', False, help='True if use UDP otherwise TCP is used.')
                loader.add_attr_float('val_float', 0.8, help='float test value')
                loader.add_attr_dict('val_dict', {'a':1,'b':2,'c':3}, help='dict test value')
                loader.add_attr_list('val_list', [1,2,3], help='list test value')
                loader.add_attr_path('home', '../', help='path test value')

        class MyClass:
                def __init__(self):
                        self.conf = configure_module(conf)
                        self.addr = self.conf.addr
                        self.port = self.conf.port
                        self.conf.logger.info(self.conf)

* config.ini

        [server_conf]
        #addr = 0.0.0.0
        port = 8888


## config file generation

You can print config.ini template

        python -m ifconf server.config

## Install

You can install this package by pip

        pip3 install ifconf

If you need to use 'mutable' option, install 'recordclass' as well.

        pip3 install ifconf recordclass

If you got an error such as 'error: command 'x86_64-linux-gnu-gcc' failed with exit status 1', you need to install build essentials.

        sudo apt-get install build-essential libssl-dev libffi-dev python3-dev





