Merge pull request #59 from astronomy-commons/delucchi/docs

Add console entry points for import tool.

pyproject.toml

@@ -54,5 +54,9 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 write_to = "src/hipscat_import/_version.py"
 
+[project.scripts]
+hipscat-import = "hipscat_import.control:main"
+hc = "hipscat_import.control:main"
+
 [tool.pytest.ini_options]
 timeout = 1

src/hipscat_import/__init__.py

@@ -2,6 +2,7 @@
 
 from .arguments import ImportArguments
 from .command_line_arguments import parse_command_line
+from .control import main
 from .file_readers import (
     CsvReader,
     FitsReader,

src/hipscat_import/__main__.py

@@ -1,9 +1,7 @@
 """Main method to enable command line execution"""
 
-import sys
 
-import hipscat_import.run_import as runner
-from hipscat_import.command_line_arguments import parse_command_line
+from hipscat_import.control import main
 
 if __name__ == "__main__":
-    runner.run(parse_command_line(sys.argv[1:]))
+    main()

src/hipscat_import/control.py

@@ -0,0 +1,10 @@
+"""Flow control and scripting entry points."""
+import sys
+
+import hipscat_import.run_import as runner
+from hipscat_import.command_line_arguments import parse_command_line
+
+
+def main():
+    """Wrapper of main for setuptools."""
+    runner.run(parse_command_line(sys.argv[1:]))