feat: add login command

CHANGELOG.md

@@ -19,6 +19,7 @@ These are the section headers that we use:
 ### Added
 
 - Added `login` function in `argilla.client.login` to login into an Argilla server and store the credentials locally ([#3582](https://github.com/argilla-io/argilla/pull/3582)).
+- Added `login` command to login into an Argilla server ([#3600](https://github.com/argilla-io/argilla/pull/3600)).
 
 ### Changed
 

src/argilla/__main__.py

@@ -14,15 +14,16 @@
 #  limitations under the License.
 
 
-from argilla.tasks import database_app, server_app, training_app, users_app
+from argilla.tasks import database_app, login_app, server_app, training_app, users_app
 from argilla.tasks.async_typer import AsyncTyper
 
 app = AsyncTyper(rich_help_panel=True, help="Argilla CLI", no_args_is_help=True)
 
-app.add_typer(users_app, name="users")
 app.add_typer(database_app, name="database")
-app.add_typer(training_app, name="train")
+app.add_typer(login_app, name="login")
 app.add_typer(server_app, name="server")
+app.add_typer(training_app, name="train")
+app.add_typer(users_app, name="users")
 
 if __name__ == "__main__":
     app()

src/argilla/client/login.py

@@ -49,6 +49,10 @@ def remove(cls) -> None:
 
         ARGILLA_CREDENTIALS_FILE.unlink()
 
+    @classmethod
+    def exists(cls) -> bool:
+        return ARGILLA_CREDENTIALS_FILE.exists()
+
 
 def login(
     api_url: str, api_key: str, workspace: Optional[str] = None, extra_headers: Optional[Dict[str, str]] = None

src/argilla/tasks/__init__.py

@@ -13,6 +13,7 @@
 #  limitations under the License.
 
 from .database import app as database_app
+from .login import app as login_app
 from .server import app as server_app
 from .training import app as training_app
 from .users import app as users_app

src/argilla/tasks/callback.py

@@ -0,0 +1,26 @@
+#  Copyright 2021-present, the Recognai S.L. team.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+import typer
+
+from argilla.client.api import init
+from argilla.client.login import ArgillaCredentials
+
+
+def init_callback() -> None:
+    if not ArgillaCredentials.exists():
+        typer.echo("You are not logged in. Please run `argilla login` to login to an Argilla server.")
+        raise typer.Exit(code=1)
+
+    init()

src/argilla/tasks/login/__init__.py

@@ -0,0 +1,18 @@
+#  Copyright 2021-present, the Recognai S.L. team.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from .__main__ import app
+
+if __name__ == "__main__":
+    app()

src/argilla/tasks/login/__main__.py

@@ -0,0 +1,55 @@
+#  Copyright 2021-present, the Recognai S.L. team.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from typing import Optional
+
+import typer
+
+app = typer.Typer(invoke_without_command=True)
+
+
+@app.callback(help="Login to an Argilla server")
+def login(
+    api_url: str = typer.Option(..., help="The URL of the Argilla server to login"),
+    api_key: str = typer.Option(..., help="The API key to use to login to the Argilla server", prompt="API Key"),
+    workspace: Optional[str] = typer.Option(
+        None, help="The default workspace over which the operations will be performed"
+    ),
+    extra_headers: Optional[str] = typer.Option(
+        None, help="A JSON string with extra headers to be sent in the requests to the Argilla server"
+    ),
+):
+    import json
+
+    from argilla.client.login import login as login_func
+
+    try:
+        if extra_headers:
+            headers = json.loads(extra_headers)
+        else:
+            headers = {}
+        login_func(api_url=api_url, api_key=api_key, workspace=workspace, extra_headers=headers)
+        typer.echo(f"Logged in successfully to '{api_url}' Argilla server!")
+    except json.JSONDecodeError as e:
+        typer.echo("The provided extra headers are not a valid JSON string.")
+        raise typer.Exit(code=1) from e
+    except ValueError as e:
+        typer.echo(
+            f"Could not login to the '{api_url}' Argilla server. Please check the provided credentials and try again."
+        )
+        raise typer.Exit(code=1) from e
+
+
+if __name__ == "__main__":
+    app()

tests/unit/tasks/login/__init__.py

@@ -0,0 +1,13 @@
+#  Copyright 2021-present, the Recognai S.L. team.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.

tests/unit/tasks/login/test_login.py

@@ -0,0 +1,64 @@
+#  Copyright 2021-present, the Recognai S.L. team.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from click.testing import CliRunner
+    from pytest_mock import MockerFixture
+    from typer import Typer
+
+
+def test_login(cli_runner: "CliRunner", cli: "Typer", mocker: "MockerFixture"):
+    login_mock = mocker.patch("argilla.client.login.login")
+
+    result = cli_runner.invoke(
+        cli,
+        'login --api-url http://localhost:6900 --api-key api.key --workspace my_workspace --extra-headers "{\\"X-Unit-Test\\": \\"true\\"}"',
+    )
+
+    assert result.exit_code == 0
+    login_mock.assert_called_once_with(
+        api_url="http://localhost:6900",
+        api_key="api.key",
+        workspace="my_workspace",
+        extra_headers={"X-Unit-Test": "true"},
+    )
+
+
+def test_login_fails(cli_runner: "CliRunner", cli: "Typer", mocker: "MockerFixture"):
+    login_mock = mocker.patch("argilla.client.login.login")
+    login_mock.side_effect = ValueError
+
+    result = cli_runner.invoke(
+        cli,
+        'login --api-url http://localhost:6900 --api-key api.key --workspace my_workspace --extra-headers "{\\"X-Unit-Test\\": \\"true\\"}"',
+    )
+
+    assert result.exit_code == 1
+    login_mock.assert_called_once_with(
+        api_url="http://localhost:6900",
+        api_key="api.key",
+        workspace="my_workspace",
+        extra_headers={"X-Unit-Test": "true"},
+    )
+
+
+def test_login_with_invalid_extra_headers(cli_runner: "CliRunner", cli: "Typer"):
+    result = cli_runner.invoke(
+        cli,
+        'login --api-url http://localhost:6900 --api-key api.key --workspace my_workspace --extra-headers "{\\"X-Unit-Test\\": \\"true\\""',
+    )
+
+    assert result.exit_code == 1