def init(project_dir):
"""
Initialize and configure a new whylogs project.
This guided input walks the user through setting up a new project and also
onboards a new developer in an existing project.
It scaffolds directories, sets up notebooks, creates a project file, and
appends to a `.gitignore` file.
"""
echo(INTRO_MESSAGE, fg="green")
project_dir = os.path.abspath(project_dir)
echo(f"Project path: {project_dir}")
is_project_dir_empty = len(os.listdir(path=project_dir)) == 0
if not is_project_dir_empty:
echo(EMPTY_PATH_WARNING, fg="yellow")
if not click.confirm(OVERRIDE_CONFIRM, default=False, show_default=True):
echo(DOING_NOTHING_ABORTING)
sys.exit(0)
os.chdir(project_dir)
echo(BEGIN_WORKFLOW)
echo(PROJECT_DESCRIPTION)
project_name = click.prompt(PROJECT_NAME_PROMPT, type=NameParamType())
echo(f"Using project name: {project_name}", fg="green")
echo(PIPELINE_DESCRIPTION)
pipeline_name = click.prompt(
"Pipeline name (leave blank for default pipeline name)",
type=NameParamType(),
default="default-pipeline",
)
echo(f"Using pipeline name: {pipeline_name}", fg="green")
output_path = click.prompt("Specify the whylogs output path",
default="output",
show_default=True)
echo(f"Using output path: {output_path}", fg="green")
writer = WriterConfig("local", ["all"], output_path)
session_config = SessionConfig(project_name,
pipeline_name,
writers=[writer],
verbose=False)
config_yml = os.path.join(project_dir, WHYLOGS_YML)
with open(file=config_yml, mode="wt") as f:
session_config.to_yaml(f)
echo(f"Config YAML file was written to: {config_yml}\n")
echo(
"To get started with a whylogs session, use whylogs.get_or_created_session() in the project folder.",
fg="green",
)
def init(project_dir):
"""
Initialize and configure a new whylogs project.
This guided input walks the user through setting up a new project and also
on-boards a new developer in an existing project.
It scaffolds directories, sets up notebooks, creates a project file, and
appends to a `.gitignore` file.
"""
echo(INTRO_MESSAGE, fg="green")
project_dir = os.path.abspath(project_dir)
echo(f"Project path: {project_dir}")
is_project_dir_empty = len(os.listdir(path=project_dir)) == 0
if not is_project_dir_empty:
echo(EMPTY_PATH_WARNING, fg="yellow")
if not click.confirm(OVERRIDE_CONFIRM, default=False, show_default=True):
echo(DOING_NOTHING_ABORTING)
sys.exit(0)
os.chdir(project_dir)
echo(BEGIN_WORKFLOW)
echo(PROJECT_DESCRIPTION)
project_name = click.prompt(PROJECT_NAME_PROMPT, type=NameParamType())
echo(f"Using project name: {project_name}", fg="green")
echo(PIPELINE_DESCRIPTION)
pipeline_name = click.prompt(
"Pipeline name (leave blank for default pipeline name)",
type=NameParamType(),
default="default-pipeline",
)
echo(f"Using pipeline name: {pipeline_name}", fg="green")
output_path = click.prompt(
"Specify the whylogs output path", default="output", show_default=True
)
echo(f"Using output path: {output_path}", fg="green")
writer = WriterConfig("local", ["all"], output_path)
session_config = SessionConfig(
project_name, pipeline_name, writers=[writer], verbose=False
)
echo("Adding example notebooks to your workspace")
git = shutil.which("git")
if git is None:
echo(
"We can't seem to find git utility on your system. We'll have kip this step"
)
echo(
"You can check out our repo on: https://github.com/whylabs/whylogs-examples"
)
else:
# do git checkout here
tmp_path = tempfile.mkdtemp("profiler")
subprocess.run(
[git, "clone", "--depth", "1", _EXAMPLE_REPO],
cwd=tmp_path,
check=True,
)
example_python = os.path.join(tmp_path, "whylogs-examples", "python")
files = os.listdir(example_python)
for f in files:
shutil.copy(os.path.join(example_python, f), os.path.join(project_dir, f))
shutil.rmtree(tmp_path)
config_yml = os.path.join(project_dir, WHYLOGS_YML)
with open(file=config_yml, mode="wt") as f:
session_config.to_yaml(f)
echo(f"Config YAML file was written to: {config_yml}\n")
if click.confirm(INITIAL_PROFILING_CONFIRM, default=True):
echo(DATA_SOURCE_MESSAGE)
choices = [
"CSV on the file system",
]
for i in range(len(choices)):
echo(f"\t{i + 1}. {choices[i]}")
choice = click.prompt("", type=click.IntRange(min=1, max=len(choices)))
assert choice == 1
full_input = profile_csv(session_config, project_dir)
echo(
f"You should find the whylogs output under: {os.path.join(project_dir, output_path, project_name)}",
fg="green",
)
echo(GENERATE_NOTEBOOKS)
# Hack: Takes first all numeric directory as generated datetime for now
output_full_path = os.path.join(project_dir, output_path)
generated_datetime = list(
filter(lambda x: re.match("[0-9]*", x), os.listdir(output_full_path))
)[0]
full_output_path = os.path.join(output_path, generated_datetime)
echo(f"You should find the output under: {full_output_path}")
echo(OBSERVATORY_EXPLANATION)
echo("Your original data (CSV file) will remain locally.")
should_open = click.confirm(
"Would you like to proceed to WhyLabs Playground to see how our data visualization works?",
default=False,
show_default=True,
)
if should_open:
webbrowser.open("https://try.whylabsapp.com/?utm_source=whylogs")
echo(DONE)
else:
echo("Skip initial profiling and notebook generation")
echo(DONE)
def init(project_dir):
"""
Initialize and configure a new WhyLogs project.
This guided input walks the user through setting up a new project and also
onboards a new developer in an existing project.
It scaffolds directories, sets up notebooks, creates a project file, and
appends to a `.gitignore` file.
"""
echo(INTRO_MESSAGE, fg="green")
project_dir = os.path.abspath(project_dir)
echo(f"Project path: {project_dir}")
is_project_dir_empty = len(os.listdir(path=project_dir)) == 0
if not is_project_dir_empty:
echo(EMPTY_PATH_WARNING, fg="yellow")
if not click.confirm(OVERRIDE_CONFIRM, default=False, show_default=True):
echo(DOING_NOTHING_ABORTING)
sys.exit(0)
os.chdir(project_dir)
echo(BEGIN_WORKFLOW)
echo(PROJECT_DESCRIPTION)
project_name = click.prompt(PROJECT_NAME_PROMPT, type=NameParamType())
echo(f"Using project name: {project_name}", fg="green")
echo(PIPELINE_DESCRIPTION)
pipeline_name = click.prompt(
"Pipeline name (leave blank for default pipeline name)",
type=NameParamType(),
default="default-pipeline",
)
echo(f"Using pipeline name: {pipeline_name}", fg="green")
output_path = click.prompt("Specify the WhyLogs output path",
default="output",
show_default=True)
echo(f"Using output path: {output_path}", fg="green")
writer = WriterConfig("local", ["all"], output_path)
session_config = SessionConfig(project_name,
pipeline_name,
writers=[writer],
verbose=False)
config_yml = os.path.join(project_dir, "whylogs.yml")
with open(file=config_yml, mode="w") as f:
session_config.to_yaml(f)
echo(f"Config YAML file was written to: {config_yml}\n")
if click.confirm(INITIAL_PROFILING_CONFIRM, default=True):
echo(DATA_SOURCE_MESSAGE)
choices = [
"CSV on the file system",
]
for i in range(len(choices)):
echo(f"\t{i + 1}. {choices[i]}")
choice = click.prompt("", type=click.IntRange(min=1, max=len(choices)))
assert choice == 1
full_input = profile_csv(session_config, project_dir)
echo(
f"You should find the WhyLogs output under: {os.path.join(project_dir, output_path, project_name)}",
fg="green",
)
echo(GENERATE_NOTEBOOKS)
# Hack: Takes first all numeric directory as generated datetime for now
output_full_path = os.path.join(project_dir, output_path)
generated_datetime = list(
filter(lambda x: re.match("[0-9]*", x),
os.listdir(output_full_path)))[0]
full_output_path = os.path.join(output_path, generated_datetime)
generate_notebooks(
project_dir,
{
"INPUT_PATH": full_input,
"PROFILE_DIR": full_output_path,
"GENERATED_DATETIME": generated_datetime,
},
)
echo(
f'You should find the output under: {os.path.join(project_dir, "notebooks")}'
)
echo(OBSERVATORY_EXPLANATION)
echo("Your original data (CSV file) will remain locally.")
should_upload = click.confirm(
"Would you like to proceed with sending us your statistic data?",
default=False,
show_default=True,
)
if should_upload:
echo("Uploading data to WhyLabs Observatory...")
sleep(5)
webbrowser.open(
"https://www.figma.com/proto/QBTk0N6Ad0D9hRijjhBaE0/Usability-Study-Navigation?node-id=1%3A90&viewport=185%2C235%2C0.25&scaling=min-zoom"
)
else:
echo("Skip uploading")
echo(DONE)
else:
echo("Skip initial profiling and notebook generation")
echo(DONE)