Coding

Standalone scripting guidelines

schimpy has a number of standalone command line scripts. In order to make sure that our command line scripts work well please follow these guidelines:

1. The script should have a if __name__ == __main__ block that does nothing but call a function called main().
2. The main() function should be called main().
3. In main, the main thing you want to do is call create_argparse(), gather concrete arguments and call a function with named arguments.This will be called the work function
4. As an extension of (3), please do not pass around argparse objects, dictionaries or namespaces unless you are passing through arguments to libraries that expect this (matplotlib for instance). Otherwise it thwarts documentation and API usage of the concrete function.
5. The concrete function should, be named the same thing as the file to reflect the centrality of purpose.
6. The concrete function should be documented using numpydoc conventions.
7. The function create_argparse should be named create_argparse. We use this to hook up to sphinx.
8. Once stable, recommend you add standalones as entry points in setup.py.

For newer libraries feel free to use fancier CLI methods.