Release v0.4.3 (#6)

Author: bennuttall

docs/changelog.rst

@@ -8,6 +8,14 @@ Changelog
     Once the library reaches v1.0, it will be considered stable. Please consider giving feedback to
     help stabilise the API.
 
+Release 0.4.3 (2025-07-25)
+==========================
+
+- Added :attr:`~hostedpi.pi.Pi.ipv6_ssh_hostname` and :attr:`~hostedpi.pi.Pi.hostname` properties to
+  :class:`~hostedpi.pi.Pi`
+- Changed :attr:`~hostedpi.pi.Pi.ipv6_ssh_command` and :attr:`~hostedpi.pi.Pi.ipv6_ssh_config` to
+  use the hostname rather than the IPv6 address
+
 Release 0.4.2 (2025-07-19)
 ==========================
 

docs/cli/ssh/command.rst

@@ -43,7 +43,7 @@ Output the IPv6 SSH command for a Pi:
 .. code-block:: console
 
     $ hostedpi ssh command mypi --ipv6
-    ssh root@[2a00:1098:8:5b::1]
+    ssh root@mypi.hostedpi.com
 
 .. note::
 

docs/cli/ssh/config.rst

@@ -61,7 +61,7 @@ Output the IPv6 SSH config for a Pi:
     $ hostedpi ssh config mypi --ipv6
     Host mypi
         user root
-        hostname 2a00:1098:8:5b::1
+        hostname mypi.hostedpi.com
 
 Output the IPv4 SSH config for multiple Pis:
 

docs/conf.py

@@ -7,7 +7,7 @@
 import sphinx_rtd_theme
 
 
-hostedpi_version = "0.4.2"
+hostedpi_version = "0.4.3"
 
 
 # -- General configuration ------------------------------------------------

hostedpi/pi.py

@@ -250,26 +250,40 @@ def provision_status(self) -> str:
         """
         return self.info.provision_status
 
+    @property
+    def hostname(self) -> str:
+        """
+        The hostname of the Pi
+        """
+        return f"{self.name}.hostedpi.com"
+
     @property
     def ipv4_ssh_hostname(self) -> str:
         """
-        The hostname to use when connecting to the Pi over IPv4
+        The hostname to use when connecting to the Pi over SSH using IPv4
+        """
+        return f"ssh.{self.hostname}"
+
+    @property
+    def ipv6_ssh_hostname(self) -> str:
+        """
+        The hostname to use when connecting to the Pi over SSH using IPv6
         """
-        return f"ssh.{self.name}.hostedpi.com"
+        return self.hostname
 
     @property
     def ipv4_ssh_command(self) -> str:
         """
-        The SSH command required to connect to the Pi over IPv4
+        The SSH command required to connect to the Pi over SSH using IPv4
         """
         return f"ssh -p {self.ipv4_ssh_port} root@{self.ipv4_ssh_hostname}"
 
     @property
     def ipv6_ssh_command(self) -> str:
         """
-        The SSH command required to connect to the Pi over IPv6
+        The SSH command required to connect to the Pi over SSH using IPv6
         """
-        return f"ssh root@[{self.ipv6_address}]"
+        return f"ssh root@{self.ipv6_ssh_hostname}"
 
     @property
     def ipv4_ssh_config(self) -> str:
@@ -280,7 +294,7 @@ def ipv4_ssh_config(self) -> str:
         return f"""Host {self.name}
     user root
     port {self.ipv4_ssh_port}
-    hostname ssh.{self.name}.hostedpi.com
+    hostname {self.ipv4_ssh_hostname}
         """.strip()
 
     @property
@@ -291,7 +305,7 @@ def ipv6_ssh_config(self) -> str:
         """
         return f"""Host {self.name}
     user root
-    hostname {self.ipv6_address}
+    hostname {self.ipv6_ssh_hostname}
         """.strip()
 
     @property
@@ -302,7 +316,7 @@ def url(self) -> str:
         .. note::
             Note that a web server must be installed on the Pi for the URL to be resolvable.
         """
-        return f"http://www.{self.name}.hostedpi.com"
+        return f"http://www.{self.hostname}"
 
     @property
     def url_ssl(self) -> str:
@@ -315,7 +329,7 @@ def url_ssl(self) -> str:
 
             See https://letsencrypt.org/
         """
-        return f"https://www.{self.name}.hostedpi.com"
+        return f"https://www.{self.hostname}"
 
     @property
     def ssh_keys(self) -> set[str]:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hostedpi"
-version = "0.4.2"
+version = "0.4.3"
 description = "Python interface to the Mythic Beasts Hosted Pi API"
 authors = [
     {name = "Ben Nuttall", email = "[email protected]"}

tests/test_pi.py

@@ -205,14 +205,14 @@ def test_pi_get_info(pi_name, pi_info_basic, auth, pi_info_response, pi_info_ful
     assert pi.memory_gb == 1
     assert pi.nic_speed == 100
     assert pi.ipv4_ssh_command == "ssh -p 5100 [email protected]"
-    assert pi.ipv6_ssh_command == "ssh root@[2a00:1098:8:64::1]"
+    assert pi.ipv6_ssh_command == "ssh root@test-pi.hostedpi.com"
     assert pi.ipv6_address == IPv6Address("2a00:1098:8:64::1")
     assert pi.ipv6_network == IPv6Network("2a00:1098:0008:6400::/56")
     assert pi.initialised_keys is False
     assert pi.location == "CLL"
     v4c = "Host test-pi\n    user root\n    port 5100\n    hostname ssh.test-pi.hostedpi.com"
     assert pi.ipv4_ssh_config == v4c
-    v6c = "Host test-pi\n    user root\n    hostname 2a00:1098:8:64::1"
+    v6c = "Host test-pi\n    user root\n    hostname test-pi.hostedpi.com"
     assert pi.ipv6_ssh_config == v6c
     assert pi.status == "Powered on"
     assert pi.provision_status == "live"

tests/test_picloud.py

@@ -543,15 +543,13 @@ def test_get_ipv6_ssh_config(auth, pis_response, pi_info_response, pi_info_respo
         pi_info_response_2,
     ]
     ipv6_config = cloud.ipv6_ssh_config
-    assert auth._api_session.get.call_count == 3
+    assert auth._api_session.get.call_count == 1
     assert auth._api_session.get.call_args_list[0][0][0] == cloud._api_url + "servers"
-    assert auth._api_session.get.call_args_list[1][0][0] == cloud._api_url + "servers/pi1"
-    assert auth._api_session.get.call_args_list[2][0][0] == cloud._api_url + "servers/pi2"
     assert ipv6_config.count("\n") == 5
     lines = ipv6_config.splitlines()
     assert lines[0] == "Host pi1"
     assert lines[1] == "    user root"
-    assert lines[2] == "    hostname 2a00:1098:8:64::1"
+    assert lines[2] == "    hostname pi1.hostedpi.com"
     assert lines[3] == "Host pi2"
     assert lines[4] == "    user root"
-    assert lines[5] == "    hostname 2a00:1098:8:64::2"
+    assert lines[5] == "    hostname pi2.hostedpi.com"