Use ade at the command line

ansible · Jan 23, 2024 · aa0a89a · aa0a89a
1 parent cc251b9
commit aa0a89a
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ By placing collections into the python site-packages directory they are discover
 $ pip install ansible-dev-environment --user
 $ git clone <collection_repo>
 $ cd <collection_repo>
-$ ansible-dev-environment install -e .\[test] --venv venv
+$ ade install -e .\[test] --venv venv
 INFO: Found collection name: network.interfaces from /home/bthornto/github/network.interfaces/galaxy.yml.
 INFO: Creating virtual environment: /home/bthornto/github/network.interfaces/venv
 INFO: Virtual environment: /home/bthornto/github/network.interfaces/venv
@@ -44,7 +44,7 @@ source venv/bin/activate
 ### Tearing down the development environment
 
 ```
-$ ansible-dev-environment uninstall ansible.scm
+$ ade uninstall ansible.scm
 INFO     Found collection name: ansible.scm from /home/bthornto/github/ansible.scm/galaxy.yml.
 INFO     Requirements file /home/bthornto/github/ansible.scm/requirements.txt is empty, skipping
 INFO     Uninstalling python requirements from /home/bthornto/github/ansible.scm/test-requirements.txt
@@ -57,8 +57,8 @@ INFO     Removed collection root: /home/bthornto/github/ansible.scm/venv/lib64/p
 
 ## Help
 
-`ansible-dev-environment --help`
+`ade --help`
 
-`ansible-dev-environment install --help`
+`ade install --help`
 
-`ansible-dev-environment uninstall --help`
+`ade uninstall --help`
diff --git a/docs/index.md b/docs/index.md
@@ -22,7 +22,7 @@ By placing collections into the python site-packages directory they are discover
 $ pip install ansible-dev-environment --user
 $ git clone <collection_repo>
 $ cd <collection_repo>
-$ ansible-dev-environment install -e .\[test] --venv venv
+$ ade install -e .\[test] --venv venv
 INFO: Found collection name: network.interfaces from /home/bthornto/github/network.interfaces/galaxy.yml.
 INFO: Creating virtual environment: /home/bthornto/github/network.interfaces/venv
 INFO: Virtual environment: /home/bthornto/github/network.interfaces/venv
@@ -44,7 +44,7 @@ source venv/bin/activate
 ### Tearing down the development environment
 
 ```
-$ ansible-dev-environment uninstall ansible.scm
+$ ade uninstall ansible.scm
 INFO     Found collection name: ansible.scm from /home/bthornto/github/ansible.scm/galaxy.yml.
 INFO     Requirements file /home/bthornto/github/ansible.scm/requirements.txt is empty, skipping
 INFO     Uninstalling python requirements from /home/bthornto/github/ansible.scm/test-requirements.txt
@@ -57,8 +57,8 @@ INFO     Removed collection root: /home/bthornto/github/ansible.scm/venv/lib64/p
 
 ## Help
 
-`ansible-dev-environment --help`
+`ade --help`
 
-`ansible-dev-environment install --help`
+`ade install --help`
 
-`ansible-dev-environment uninstall --help`
+`ade uninstall --help`
diff --git a/pyproject.toml b/pyproject.toml
@@ -32,7 +32,7 @@ readme = "README.md"
 requires-python = ">=3.10"
 
 [project.scripts]
-ansible-dev-environment = "ansible_dev_environment.cli:main"
+ade = "ansible_dev_environment.cli:main"
 
 [project.urls]
 changelog = "https://github.com/ansible/ansible-dev-environment/releases"

diff --git a/src/ansible_dev_environment/subcommands/checker.py b/src/ansible_dev_environment/subcommands/checker.py
@@ -122,7 +122,7 @@ def _collection_deps(self: Checker) -> None:  # noqa: C901, PLR0912, PLR0915
                         f" {dep} {version} but it is not installed."
                     )
                     self._output.error(err)
-                    msg = f"Try running `ansible-dev-environment install {dep}`"
+                    msg = f"Try running `ade install {dep}`"
                     self._output.hint(msg)
                     missing = True
 
@@ -136,7 +136,7 @@ def _python_deps(self: Checker) -> None:
         if self._system_dep_missing:
             msg = "System packages are missing. Python dependency checking may fail."
             self._output.warning(msg)
-            msg = "Install system packages and re-run `ansible-dev-environment check`."
+            msg = "Install system packages and re-run `ade check`."
             self._output.hint(msg)
         missing_file = self._config.venv_cache_dir / "pip-report.txt"
         command = (

diff --git a/tests/integration/test_basic.py b/tests/integration/test_basic.py
@@ -41,7 +41,7 @@ def test_venv(
     monkeypatch.setattr(
         "sys.argv",
         [
-            "ansible-dev-environment",
+            "ade",
             "install",
             str(tmp_path / "cisco.nxos"),
             "--venv=venv",
@@ -57,7 +57,7 @@ def test_venv(
 
     monkeypatch.setattr(
         "sys.argv",
-        ["ansible-dev-environment", "list", "--venv=venv"],
+        ["ade", "list", "--venv=venv"],
     )
     with pytest.raises(SystemExit):
         main()
@@ -70,7 +70,7 @@ def test_venv(
     monkeypatch.setattr(
         "sys.argv",
         [
-            "ansible-dev-environment",
+            "ade",
             "uninstall",
             "ansible.utils",
             "--venv=venv",
@@ -83,7 +83,7 @@ def test_venv(
 
     monkeypatch.setattr(
         "sys.argv",
-        ["ansible-dev-environment", "inspect", "--venv=venv", "--no-ansi"],
+        ["ade", "inspect", "--venv=venv", "--no-ansi"],
     )
     with pytest.raises(SystemExit):
         main()
@@ -95,7 +95,7 @@ def test_venv(
 
     monkeypatch.setattr(
         "sys.argv",
-        ["ansible-dev-environment", "check", "--venv=venv"],
+        ["ade", "check", "--venv=venv"],
     )
     with pytest.raises(SystemExit):
         main()
@@ -112,7 +112,7 @@ def test_non_local(
     monkeypatch.setattr(
         "sys.argv",
         [
-            "ansible-dev-environment",
+            "ade",
             "install",
             "ansible.scm",
             f"--venv={tmp_path / 'venv'}",
@@ -125,7 +125,7 @@ def test_non_local(
     assert string in captured.out
     monkeypatch.setattr(
         "sys.argv",
-        ["ansible-dev-environment", "tree", f"--venv={tmp_path / 'venv'}"],
+        ["ade", "tree", f"--venv={tmp_path / 'venv'}"],
     )
     with pytest.raises(SystemExit):
         main()
@@ -147,7 +147,7 @@ def test_requirements(
     monkeypatch.setattr(
         "sys.argv",
         [
-            "ansible-dev-environment",
+            "ade",
             "install",
             f"--venv={tmp_path / 'venv'}",
             "-r",
@@ -162,7 +162,7 @@ def test_requirements(
     monkeypatch.setattr(
         "sys.argv",
         [
-            "ansible-dev-environment",
+            "ade",
             "uninstall",
             f"--venv={tmp_path / 'venv'}",
             "-r",
@@ -179,7 +179,7 @@ def test_requirements(
 
     monkeypatch.setattr(
         "sys.argv",
-        ["ansible-dev-environment", "list", f"--venv={tmp_path / 'venv'}"],
+        ["ade", "list", f"--venv={tmp_path / 'venv'}"],
     )
     with pytest.raises(SystemExit):
         main()