sodadata/docs

Make it Clear that Soda Core Available from Python (Not just a CLI)

Closed this issue · 1 comments

I misinterpreted a couple of pages of the documentation, and wrongly thought that Soda Core was only available as a CLI. So I started building a wrapper for the CLI until I realized my mistake.

On this page:
https://docs.soda.io/soda-core/programmatic.html

Can we make it clear that there really is an option to scan from python?

For example, the title could be "Scan from Python" or "Scan from within Python"

or the first paragraph could say:
"An alternative to the command line interface is to call soda core directly from python"

Also on this page:
https://docs.soda.io/soda-core/installation.html

To improve clarity that soda is available as a python interface it would also be helpful to change this paragraph from:

"Soda Core is a command-line interface (CLI) tool that enables you to scan the data in your data source to surface invalid, missing, or unexpected data. "

to

"Soda Core is a tool that enables you to scan the data in your data source to surface invalid, missing, or unexpected data. Soda Core can be run from command line or directly from python."

Excellent feedback, @jackdesert. I have added content as you suggested, and a little bit beyond for consistency and clarity. Many thanks!