cli

Module with Data-Lunch's command line.

The command line is built with click.

Call data-lunch --help from the terminal inside an environment where the dlunch package is installed.

Modules:

Name	Description
auth	Module with classes and functions used for authentication and password handling.

Functions:

Name	Description
add_privileged_user	Add privileged users (with or without admin privileges).
add_user_credential	Add users credentials to credentials table (used by basic authentication).
clean_tables	Clean 'users', 'menu', 'orders' and 'flags' tables.
cli	Command line interface for managing Data-Lunch database and users.
credentials	Manage users credentials for basic authentication.
db	Manage the database.
delete_database	Delete the database.
delete_table	Drop a single table from database.
export_table_to_csv	Export a single table to a csv file.
init_database	Initialize the database.
list_users_name	List users.
load_table	Load a single table from a csv file.
main	Main command line entrypoint.
remove_privileged_user	Remove user from both privileged users and basic login credentials table.
remove_user_credential	Remove user from both privileged users and basic login credentials table.
table	Manage tables in database.
users	Manage privileged users and admin privileges.

Attributes:

Name	Type	Description
__version__	str	Data-Lunch command line version.

__version__ module-attribute

__version__: str = version

Data-Lunch command line version.

add_privileged_user

add_privileged_user(obj, user, is_admin)

Add privileged users (with or without admin privileges).

Source code in dlunch/cli.py

@users.command("add")
@click.argument("user")
@click.option("--admin", "is_admin", is_flag=True, help="add admin privileges")
@click.pass_obj
def add_privileged_user(obj, user, is_admin):
    """Add privileged users (with or without admin privileges)."""

    # Add privileged user to 'privileged_users' table
    auth.add_privileged_user(
        user=user,
        is_admin=is_admin,
        config=obj["config"],
    )

    click.secho(f"User '{user}' added (admin: {is_admin})", fg="green")

add_user_credential

add_user_credential(
    obj, user, password, is_admin, is_guest
)

Add users credentials to credentials table (used by basic authentication).

Source code in dlunch/cli.py

@credentials.command("add")
@click.argument("user")
@click.argument("password")
@click.option("--admin", "is_admin", is_flag=True, help="add admin privileges")
@click.option(
    "--guest",
    "is_guest",
    is_flag=True,
    help="add user as guest (not added to privileged users)",
)
@click.pass_obj
def add_user_credential(obj, user, password, is_admin, is_guest):
    """Add users credentials to credentials table (used by basic authentication)."""

    # Add a privileged users only if guest option is not active
    if not is_guest:
        auth.add_privileged_user(
            user=user,
            is_admin=is_admin,
            config=obj["config"],
        )
    # Add hashed password to credentials table
    auth.add_user_hashed_password(user, password, config=obj["config"])

    click.secho(f"User '{user}' added", fg="green")

clean_tables

clean_tables(obj)

Clean 'users', 'menu', 'orders' and 'flags' tables.

Source code in dlunch/cli.py

@db.command("clean")
@click.confirmation_option()
@click.pass_obj
def clean_tables(obj):
    """Clean 'users', 'menu', 'orders' and 'flags' tables."""

    # Drop table
    try:
        clean_tables_func(obj["config"])
        click.secho("done", fg="green")
    except Exception as e:
        # Generic error
        click.secho("Cannot clean database", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

cli

cli(ctx, hydra_overrides: tuple | None)

Command line interface for managing Data-Lunch database and users.

Source code in dlunch/cli.py

@click.group()
@click.version_option(__version__)
@click.option(
    "-o",
    "--hydra-overrides",
    "hydra_overrides",
    default=None,
    multiple=True,
    help="pass hydra override, use multiple time to add more than one override",
)
@click.pass_context
def cli(ctx, hydra_overrides: tuple | None):
    """Command line interface for managing Data-Lunch database and users."""
    # global initialization
    initialize(
        config_path="conf", job_name="data_lunch_cli", version_base="1.3"
    )
    config = compose(config_name="config", overrides=hydra_overrides)
    ctx.obj = {"config": config}

    # Auth encryption
    auth.set_app_auth_and_encryption(config)

credentials

credentials(obj)

Manage users credentials for basic authentication.

Source code in dlunch/cli.py

@cli.group()
@click.pass_obj
def credentials(obj):
    """Manage users credentials for basic authentication."""

db

db(obj)

Manage the database.

Source code in dlunch/cli.py

@cli.group()
@click.pass_obj
def db(obj):
    """Manage the database."""

delete_database

delete_database(obj)

Delete the database.

Source code in dlunch/cli.py

@db.command("delete")
@click.confirmation_option()
@click.pass_obj
def delete_database(obj):
    """Delete the database."""

    # Create database
    try:
        engine = create_engine(obj["config"])
        Data.metadata.drop_all(engine)
        click.secho("Database deleted", fg="green")
    except Exception as e:
        # Generic error
        click.secho("Cannot delete database", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

delete_table

delete_table(obj, name)

Drop a single table from database.

Source code in dlunch/cli.py

@table.command("drop")
@click.confirmation_option()
@click.argument("name")
@click.pass_obj
def delete_table(obj, name):
    """Drop a single table from database."""

    # Drop table
    try:
        engine = create_engine(obj["config"])
        metadata_obj.tables[name].drop(engine)
        click.secho(f"Table '{name}' deleted", fg="green")
    except Exception as e:
        # Generic error
        click.secho("Cannot drop table", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

export_table_to_csv

export_table_to_csv(obj, name, csv_file_path, index)

Export a single table to a csv file.

Source code in dlunch/cli.py

@table.command("export")
@click.argument("name")
@click.argument("csv_file_path")
@click.option(
    "--index/--no-index",
    "index",
    show_default=True,
    default=False,
    help="select if index is exported to csv",
)
@click.pass_obj
def export_table_to_csv(obj, name, csv_file_path, index):
    """Export a single table to a csv file."""

    click.secho(f"Export table '{name}' to CSV {csv_file_path}", fg="yellow")

    # Create dataframe
    try:
        engine = create_engine(obj["config"])
        df = pd.read_sql_table(
            name, engine, schema=obj["config"].db.get("schema", SCHEMA)
        )
    except Exception as e:
        # Generic error
        click.secho("Cannot read table", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

    # Show head
    click.echo("First three rows of the table")
    click.echo(f"{df.head(3)}\n")

    # Export table
    try:
        df.to_csv(csv_file_path, index=index)
    except Exception as e:
        # Generic error
        click.secho("Cannot write CSV", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

    click.secho("Done", fg="green")

init_database

init_database(obj, add_basic_auth_users)

Initialize the database.

Source code in dlunch/cli.py

@db.command("init")
@click.option(
    "--add-basic-auth-users",
    "add_basic_auth_users",
    is_flag=True,
    help="automatically create basic auth standard users",
)
@click.pass_obj
def init_database(obj, add_basic_auth_users):
    """Initialize the database."""

    # Create database
    create_database(obj["config"], add_basic_auth_users=add_basic_auth_users)

    click.secho(
        f"Database initialized (basic auth users: {add_basic_auth_users})",
        fg="green",
    )

list_users_name

list_users_name(obj)

List users.

Source code in dlunch/cli.py

@users.command("list")
@click.pass_obj
def list_users_name(obj):
    """List users."""

    # Clear action
    usernames = auth.list_users(config=obj["config"])
    click.secho("USERS:")
    click.secho("\n".join(usernames), fg="yellow")
    click.secho("\nDone", fg="green")

load_table

load_table(
    obj,
    name,
    csv_file_path,
    index,
    index_label,
    index_col,
    if_exists,
)

Load a single table from a csv file.

Source code in dlunch/cli.py

@table.command("load")
@click.confirmation_option()
@click.argument("name")
@click.argument("csv_file_path")
@click.option(
    "--index/--no-index",
    "index",
    show_default=True,
    default=True,
    help="select if index is loaded to table",
)
@click.option(
    "-l",
    "--index-label",
    "index_label",
    type=str,
    default=None,
    help="select index label",
)
@click.option(
    "-c",
    "--index-col",
    "index_col",
    type=str,
    default=None,
    help="select the column used as index",
)
@click.option(
    "-e",
    "--if-exists",
    "if_exists",
    type=click.Choice(["fail", "replace", "append"], case_sensitive=False),
    show_default=True,
    default="append",
    help="logict used if the table already exists",
)
@click.pass_obj
def load_table(
    obj, name, csv_file_path, index, index_label, index_col, if_exists
):
    """Load a single table from a csv file."""

    click.secho(f"Load CSV {csv_file_path} to table '{name}'", fg="yellow")

    # Create dataframe
    df = pd.read_csv(csv_file_path, index_col=index_col)

    # Show head
    click.echo("First three rows of the CSV table")
    click.echo(f"{df.head(3)}\n")

    # Load table
    try:
        engine = create_engine(obj["config"])
        df.to_sql(
            name,
            engine,
            schema=obj["config"].db.get("schema", SCHEMA),
            index=index,
            index_label=index_label,
            if_exists=if_exists,
        )
        click.secho("Done", fg="green")
    except Exception as e:
        # Generic error
        click.secho("Cannot load table", fg="red")
        click.secho(f"\n ===== EXCEPTION =====\n\n{e}", fg="red")

main

main() -> None

Main command line entrypoint.

Source code in dlunch/cli.py

def main() -> None:
    """Main command line entrypoint."""
    cli(auto_envvar_prefix="DATA_LUNCH")

remove_privileged_user

remove_privileged_user(obj, user)

Remove user from both privileged users and basic login credentials table.

Source code in dlunch/cli.py

@users.command("remove")
@click.confirmation_option()
@click.argument("user")
@click.pass_obj
def remove_privileged_user(obj, user):
    """Remove user from both privileged users and basic login credentials table."""

    # Clear action
    deleted_data = auth.remove_user(user, config=obj["config"])

    if (deleted_data["privileged_users_deleted"] > 0) or (
        deleted_data["credentials_deleted"] > 0
    ):
        click.secho(
            f"User '{user}' removed (auth: {deleted_data['privileged_users_deleted']}, cred: {deleted_data['credentials_deleted']})",
            fg="green",
        )
    else:
        click.secho(f"User '{user}' does not exist", fg="yellow")

remove_user_credential

remove_user_credential(obj, user)

Remove user from both privileged users and basic login credentials table.

Source code in dlunch/cli.py

@credentials.command("remove")
@click.confirmation_option()
@click.argument("user")
@click.pass_obj
def remove_user_credential(obj, user):
    """Remove user from both privileged users and basic login credentials table."""

    # Clear action
    deleted_data = auth.remove_user(user, config=obj["config"])

    if (deleted_data["privileged_users_deleted"] > 0) or (
        deleted_data["credentials_deleted"] > 0
    ):
        click.secho(
            f"User '{user}' removed (auth: {deleted_data['privileged_users_deleted']}, cred: {deleted_data['credentials_deleted']})",
            fg="green",
        )
    else:
        click.secho(f"User '{user}' does not exist", fg="yellow")

table

table(obj)

Manage tables in database.

Source code in dlunch/cli.py

@db.group()
@click.pass_obj
def table(obj):
    """Manage tables in database."""

users

users(obj)

Manage privileged users and admin privileges.

Source code in dlunch/cli.py

@cli.group()
@click.pass_obj
def users(obj):
    """Manage privileged users and admin privileges."""