ArgParseInator

Warning

My English really sucks! So, if you wanna to correct this documentation or to report any error, I’ll be very pleased to receive your suggestions.

email: luca800@gmail.com

documentation

Argparseinator is a silly, but useful, thing that permit you to easily add argparse‘s arguments and options to your script directly within functions and classes with the use of some decorators.

Contents:

• Getting Started
• Decorators and Function declarations
  • Add arguments to parser (ap_arg)
  • Add arguments to a function (@arg)
  • Authorize commands (@cmd_auth)
  • Function declarations
  • Enable classes (@class_args)
• Within classes
  • First way (commands container)
  • Second way (sub-commands container)
  • Shared arguments
  • Sub commands container and command arguments
  • Importing commands packages
• ArgParseInator object
  • Parameters
    • add_output
    • argpi_name
    • args
    • auth_phrase
    • auto_exit
    • config
    • never_single
    • write_name
    • write_line_name
    • default_cmd
    • error
    • ff_prefix
    • msg_on_error_only
    • setup
    • argparse_args
  • Methods
  • __argpi__, write() and writeln()
• ArgParseInated object
  • __preinator__
• Events
  • Examples
• Utils
  • init()
    • The StandAlone approch
    • The SubModules approch
    • The SubProjects approch
    • The Skeleton folder
  • get_compiled()
• Examples
  • Modular multi-commands script with sub-commands
    • Main script
    • User commands
    • Admin commands
  • Silly configuration example
  • Simple HTTP requests
  • Simple HTTP requests sub-classing ArgParseInated object
  • StandAlone Structure Example
    • Let’s create the structure
    • The running script
    • The __init__ module
    • The command module
  • SubModules structure example
    • Let’s create the structure
    • The pets/main submodule
    • The pets/main commands
    • The dog submodule
    • The dog commands
    • The running script