Use filename instead of module path for the config module

tophat / codewatch

[deprecated] Monitor and manage deeply customizable metrics about your python code using ASTs

https://codewatch.io

Apache License 2.0

38 stars 3 forks source link

Use filename instead of module path for the config module #86

Open francoiscampbell opened 5 years ago

francoiscampbell commented 5 years ago

Is your feature request related to a problem? Please describe. When calling codewatch myu_codewatch_config_module.py, we are greeted with an ImportError: No module named py. If you know that codewatch interprets config_module.py as a Python module path, you know to remove the .py, but if you don't it's an annoying interface.

Describe the solution you'd like In the event that #85 is not accepted, or if it is accepted with a manual override for the config file, make the CLI use the filename of the config module rather than a Python module path.

noahnu commented 5 years ago

I agree. Filename is much more intuitive and is what most people expect when using a CLI. With a filename you can directly pass in a file path in a script without having to do any type of transformation on the name.

noahnu commented 5 years ago

Some alternative solutions:

Support both file + module syntax:
- If "path" ends in ".py", assume file path.
- If "path" contains "/", assume file path.
- Use explicit "-f" / "--file" flag, default to module syntax.
Only support file path. It seems a bit strange that a CLI tool expects a format specific to the implementation language, although the fact that it's a tool specifically targeting the Python language makes this a bit more acceptable.