Metadata-Version: 2.1
Name: simple_parsing
Version: 0.0.3.post2
Summary: A small utility for simplifying and cleaning up argument parsing scripts.
Home-page: https://github.com/lebrice/SimpleParsing
Author: Fabrice Normandin
Author-email: fabrice.normandin@gmail.com
License: UNKNOWN
Description: [![Build Status](https://travis-ci.org/lebrice/SimpleParsing.svg?branch=master)](https://travis-ci.org/lebrice/SimpleParsing)
        
        # Simple, Elegant Argument Parsing <!-- omit in toc -->
        
        
        `simple-parsing` extends the capabilities of the builtin `argparse` module by allowing you to group related command-line arguments into neat, reusable [dataclasses](https://docs.python.org/3.7/library/dataclasses.html) and let the ArgumentParser take care of creating the arguments for you.
        
        ```python
        # examples/demo.py
        from dataclasses import dataclass
        from simple_parsing import ArgumentParser
        
        @dataclass
        class Options:
            """ Set of Options for this script. """
            experiment_name: str        # A required string parameter
            learning_rate: float = 1e-4 # An optional float parameter
        
        parser = ArgumentParser()  
        parser.add_arguments(Options, dest="options")
        args = parser.parse_args()
        
        options: Options = args.options # retrieve the parsed values
        print(options)
        ```
        
        what you get for free:
        
        ```console
        $ python examples/demo.py --experiment_name "bob"
        Options(experiment_name='bob', learning_rate=0.0001)
        
        $ python examples/demo.py --experiment_name "default" --learning_rate 1.23
        Options(experiment_name='default', learning_rate=1.23)
        
        $ python examples/demo.py --help
        usage: demo.py [-h] --experiment_name str [--learning_rate float]
        
        optional arguments:
          -h, --help            show this help message and exit
        
        Options ['options']:
          Set of Options for this script.
        
          --experiment_name str
                                a required string parameter (default: None)
          --learning_rate float
                                An optional float parameter (default: 0.0001)
        ```
        
        ## installation
        | python version |                command                  |
        |----------------|-----------------------------------------|
        |>= 3.7          | `pip install simple-parsing`            |
        |== 3.6.X        | `pip install dataclasses simple-parsing`|
        
        
        ## [Project GitHub Repository](https://github.com/lebrice/SimpleParsing)
        
        ## [Examples](https://github.com/lebrice/SimpleParsing/tree/master/examples)
        
        ## [API Documentation](https://github.com/lebrice/SimpleParsing/tree/master/docs) (Under construction)
        
        
        ## Features 
        - **Automatic "--help" strings**
        
            As developers, we want to make it easy for people coming into our projects to understand how to run them. However, a user-friendly `--help` message is often hard to write and to maintain, especially as the number of arguments increases.
        
            With `simple-parsing`, your arguments and their decriptions are defined in the same place, making your code easier to read, write, and maintain.
        
        - **Modular, Reusable Arguments *(no more copy-pasting!)***
                
            When you need to add a new group of command-line arguments similar to an existing one, instead of copy-pasting a block of `argparse` code and renaming variables, you can reuse your argument class, and let the `ArgumentParser` take care of adding `relevant` prefixes to the arguments for you:
        
            ```python
            parser.add_arguments(Options, dest="train")
            parser.add_arguments(Options, dest="valid")
            args = parser.parse_args()
            train_options: Options = args.train
            valid_options: Options = args.valid
            print(train_options)
            print(valid_options)
            ```
            ```console
            $ python examples/demo.py \
                --train.experiment_name "training" \
                --valid.experiment_name "validation"
            Options(experiment_name='training', learning_rate=0.0001)
            Options(experiment_name='validation', learning_rate=0.0001)
            ```
                
            These prefixes can also be set explicitly, or not be used at all. For more info, take a look at the [Prefixing Guide](https://github.com/lebrice/SimpleParsing/tree/master/examples/prefixing)
        
        - **Inheritance**!
        You can easily customize an existing argument class by extending it and adding your own attributes, which helps promote code reuse accross projects. For more info, take a look at the [inheritance example](https://github.com/lebrice/SimpleParsing/tree/master/examples/inheritance)
        
        - **Nesting**!: Dataclasses can be nested within dataclasses, as deep as you need!
        - [**Easy serialization**](https://github.com/lebrice/SimpleParsing/tree/master/examples/dataclasses/hyperparameters_example.py): Since dataclasses are just regular classes, its easy to add methods for easy serialization/deserialization to popular formats like `json` or `yaml`. 
        
        - **Easier parsing of lists and tuples**: This is sometimes tricky to do with regular `argparse`, but `simple-parsing` makes it a lot easier by using the standard type annotations of the `typing` module to automatically convert the parsed values to the right type for you.
        
            As an added feature, by using these type annotations, `simple-parsing` allows you to parse nested lists or tuples, as can be seen in [this example](https://github.com/lebrice/SimpleParsing/tree/master/examples/merging/multiple_lists_example.py)
        
        - Enums support
        
        - (More to come!)
        
        
        ## Examples:
        Additional examples for each of the above-mentioned features can be found in the [the project repository.](https://github.com/lebrice/SimpleParsing/tree/master/examples)
        
        
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
