Metadata-Version: 1.2
Name: dclick
Version: 0.1.1
Summary: Extend click functionnalities by allowing parameters to be passed in a config file
Home-page: https://github.com/anottergithubuser/double_click
Author: Thomas PESNEAU
Author-email: thomaspesneau@gmail.com
License: BSD license
Description: ============
        Dclick
        ============
        
        
        .. image:: https://img.shields.io/pypi/v/dclick.svg
                :target: https://pypi.python.org/pypi/dclick
        
        .. image:: https://circleci.com/gh/AnOtterGithubUser/double_click.svg?style=shield
                :target: https://circleci.com/gh/AnOtterGithubUser/double_click
        
        
        
        
        Extend click functionnalities by allowing parameters to be passed in a config file
        
        
        * Free software: BSD license
        
        
        Features
        --------
        
        * Implement a new decorator 'command_with_config' which enables to pass default values for click options in a config file
        * Performs the same checks as click regarding values passed in config file (ex: check if path exists)
        * Seamless integration with click, just replace `click.command` with `click.command_with_config`
        
        With click you would have to pass a default value directly in the code
        
        .. code-block:: python
        
            from click import command
            from click import option
        
            @command()
            @option('-n', '--n-epochs', default='Number of epochs to train the model')
            def train(n_epochs):
                run_training_for(n_epochs)
        
            if __name__ == '__main__':
                train()
        
        However, if you want to run this code with different parameters you would have to edit the code each time which is not
        great. With `dclick` you just have to change one line:
        
        .. code-block:: python
        
            from dclick import command_with_config
            from click import option
        
            @command_with_config('path_to_config.json')
            @option('-n', '--n-epochs')
            def train(n_epochs):
                run_training_for(n_epochs):
        
            if __name__ == '__main__':
                train()
        
        Just be careful that the name in the config matches the name of the option. You can pass a config as json, yaml or txt.
        Json and yaml are preferred.
        
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-06-23)
        ------------------
        
        * First release on PyPI.
        
Keywords: dclick
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
