Merge pull request #202 from SciCatProject/remove-ssh-file-transfer

Remove SSHFileTransfer

docs/developer/getting-started.rst

@@ -16,7 +16,7 @@ Development dependencies are specified in ``requirements/dev.txt`` and can be in
 Additionally, building the documentation requires `pandoc <https://pandoc.org/>`_ which is not on PyPI and needs to be installed through other means.
 (E.g. with your OS package manager.)
 
-If you want to run tests against a real backend or SSH server, you also need ``docker-compose``.
+If you want to run tests against a real backend or SFTP server, you also need ``docker-compose``.
 See `Testing <./testing.rst>`_ for what this is good for and why.
 
 Install the package
@@ -56,7 +56,7 @@ Running tests
 
             python -m pytest -n<number-of-threads>
 
-        Or to run tests against a real backend and SSH server (see setup above)
+        Or to run tests against a real backend and SFTP server (see setup above)
 
 
         .. code-block:: sh

docs/reference/index.rst

@@ -30,7 +30,6 @@ File transfer
 
    transfer.link.LinkFileTransfer
    transfer.sftp.SFTPFileTransfer
-   transfer.ssh.SSHFileTransfer
 
 Auxiliary classes
 ~~~~~~~~~~~~~~~~~

docs/release-notes.rst

@@ -48,6 +48,7 @@ Breaking changes
 ~~~~~~~~~~~~~~~~
 
 * **Dropped support for Pydantic v1.**
+* Removed deprecated ``transfer.ssh.SSHFileTransfer`` in favor of :class:`transfer.sftp.SFTPFileTransfer`.
 
 Bugfixes
 ~~~~~~~~
@@ -250,7 +251,7 @@ Breaking changes
 * A number of attributes of Dataset are now read only.
 * ``Dataset.new`` was removed, use the regular ``__init__`` method instead.
 * ``File.provide_locally`` was removed in favor of :meth:`Client.download_files`.
-* ``ESSTestFileTransfer`` was renamed to :class:`transfer.ssh.SSHFileTransfer`.
+* ``ESSTestFileTransfer`` was renamed to ``transfer.ssh.SSHFileTransfer``.
 
 Bugfixes
 ~~~~~~~~

docs/user-guide/installation.rst

@@ -7,9 +7,9 @@ Installation
 
         .. code-block:: sh
 
-            pip install scitacean[ssh]
+            pip install scitacean[sftp]
 
-        If :class:`scitacean.transfer.ssh.SSHFileTransfer` is not required, the ``ssh`` extra can be omitted.
+        If :class:`scitacean.transfer.sftp.SFTPFileTransfer` is not required, the ``sftp`` extra can be omitted.
 
     .. tab-item:: conda
 

docs/user-guide/uploading.ipynb

@@ -280,7 +280,7 @@
     "\n",
     "All files associated with a dataset will be uploaded to the same folder.\n",
     "This folder may be at the path we specify when making the dataset, i.e. `dset.source_folder`.\n",
-    "However, the folder is ultimately determined by the file transfer (in this case `SSHFileTransfer`) and it may choose to override the `source_folder` that we set.\n",
+    "However, the folder is ultimately determined by the file transfer (in this case SFTPFileTransfer`) and it may choose to override the `source_folder` that we set.\n",
     "In this example, since we don't tell the file transfer otherwise, it respects `dset.source_folder` and uploads the files to that location.\n",
     "See the [File transfer](../reference/index.rst#file-transfer) reference for information how to control this behavior.\n",
     "The reason for this is that facilities may have a specific structure on their file server and Scitacean's file transfers can be used to enforce that.\n",

pyproject.toml

@@ -42,7 +42,6 @@ dynamic = ["version"]
 "Source" = "https://github.com/SciCatProject/scitacean"
 
 [project.optional-dependencies]
-ssh = ["fabric"]
 sftp = ["paramiko"]
 test = ["filelock", "hypothesis", "pyyaml"]