Move SFTP Provider to the New Structure and fix codespell checks (apache#46155)

Author: bugraoz93

.github/boring-cyborg.yml

@@ -344,9 +344,7 @@ labelPRBasedOnFilePath:
     - providers/segment/**
 
   provider:sftp:
-    - providers/src/airflow/providers/sftp/**/*
-    - docs/apache-airflow-providers-sftp/**/*
-    - providers/tests/sftp/**/*
+    - providers/sftp/**
 
   provider:singularity:
     - providers/singularity/**

docs/.gitignore

@@ -43,6 +43,7 @@ apache-airflow-providers-presto
 apache-airflow-providers-qdrant
 apache-airflow-providers-samba
 apache-airflow-providers-segment
+apache-airflow-providers-sftp
 apache-airflow-providers-singularity
 apache-airflow-providers-ssh
 apache-airflow-providers-snowflake

docs/apache-airflow-providers-sftp/changelog.rst

@@ -0,0 +1,85 @@
+
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you 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.
+
+ .. NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+ .. IF YOU WANT TO MODIFY TEMPLATE FOR THIS FILE, YOU SHOULD MODIFY THE TEMPLATE
+    `PROVIDER_README_TEMPLATE.rst.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
+
+
+Package ``apache-airflow-providers-sftp``
+
+Release: ``5.0.0``
+
+
+`SSH File Transfer Protocol (SFTP) <https://tools.ietf.org/wg/secsh/draft-ietf-secsh-filexfer/>`__
+
+
+Provider package
+----------------
+
+This is a provider package for ``sftp`` provider. All classes for this provider package
+are in ``airflow.providers.sftp`` python package.
+
+You can find package information and changelog for the provider
+in the `documentation <https://airflow.apache.org/docs/apache-airflow-providers-sftp/5.0.0/>`_.
+
+Installation
+------------
+
+You can install this package on top of an existing Airflow 2 installation (see ``Requirements`` below
+for the minimum Airflow version supported) via
+``pip install apache-airflow-providers-sftp``
+
+The package supports the following python versions: 3.9,3.10,3.11,3.12
+
+Requirements
+------------
+
+================================  ==================
+PIP package                       Version required
+================================  ==================
+``apache-airflow``                ``>=2.9.0``
+``apache-airflow-providers-ssh``  ``>=2.1.0``
+``paramiko``                      ``>=2.9.0``
+``asyncssh``                      ``>=2.12.0``
+================================  ==================
+
+Cross provider package dependencies
+-----------------------------------
+
+Those are dependencies that might be needed in order to use all the features of the package.
+You need to install the specified provider packages in order to use them.
+
+You can install such cross-provider dependencies when installing from PyPI. For example:
+
+.. code-block:: bash
+
+    pip install apache-airflow-providers-sftp[common.compat]
+
+
+==================================================================================================================  =================
+Dependent package                                                                                                   Extra
+==================================================================================================================  =================
+`apache-airflow-providers-common-compat <https://airflow.apache.org/docs/apache-airflow-providers-common-compat>`_  ``common.compat``
+`apache-airflow-providers-openlineage <https://airflow.apache.org/docs/apache-airflow-providers-openlineage>`_      ``openlineage``
+`apache-airflow-providers-ssh <https://airflow.apache.org/docs/apache-airflow-providers-ssh>`_                      ``ssh``
+==================================================================================================================  =================
+
+The changelog for the provider package can be found in the
+`changelog <https://airflow.apache.org/docs/apache-airflow-providers-sftp/5.0.0/changelog.html>`_.

providers/sftp/README.rst

@@ -50,7 +50,7 @@ Breaking changes
 Features
 ~~~~~~~~
 
-* ``feat: retrieve sftp file attrs onces instead multiple time (#44625)``
+* ``feat: retrieve sftp file attrs once instead multiple time (#44625)``
 * ``Add host_proxy_cmd parameter to SSHHook and SFTPHook (#44565)``
 
 Misc
@@ -191,7 +191,7 @@ Features
 Bug Fixes
 ~~~~~~~~~
 
-* ``change warnning message (#36148)``
+* ``change warning message (#36148)``
 * ``Follow BaseHook connection fields method signature in child classes (#36086)``
 
 Misc

providers/src/airflow/providers/sftp/.latest-doc-only-change.txt renamed to providers/sftp/docs/.latest-doc-only-change.txt

@@ -21,7 +21,7 @@ SFTP Sensor
 Looks for either a specific file or files with a specific pattern in a server using SFTP protocol.
 To get more information about this sensor visit :class:`~airflow.providers.sftp.sensors.sftp.SFTPSensor`
 
-.. exampleinclude:: /../../providers/tests/system/sftp/example_sftp_sensor.py
+.. exampleinclude:: /../../providers/sftp/tests/system/sftp/example_sftp_sensor.py
     :language: python
     :dedent: 4
     :start-after: [START howto_operator_sftp_sensor]
@@ -39,15 +39,15 @@ op_kwargs (optional)
 
 Whatever returned by the python callable is put into XCom.
 
-.. exampleinclude:: /../../providers/tests/system/sftp/example_sftp_sensor.py
+.. exampleinclude:: /../../providers/sftp/tests/system/sftp/example_sftp_sensor.py
     :language: python
     :dedent: 4
     :start-after: [START howto_operator_sftp_sensor_decorator]
     :end-before: [END howto_operator_sftp_sensor_decorator]
 
 Checks for the existence of a file on an SFTP server in the deferrable mode:
 
-.. exampleinclude:: /../../providers/tests/system/sftp/example_sftp_sensor.py
+.. exampleinclude:: /../../providers/sftp/tests/system/sftp/example_sftp_sensor.py
     :language: python
     :dedent: 4
     :start-after: [START howto_sensor_sftp_deferrable]

providers/src/airflow/providers/sftp/CHANGELOG.rst renamed to providers/sftp/docs/changelog.rst

@@ -67,16 +67,10 @@ versions:
   - 1.1.0
   - 1.0.0
 
-dependencies:
-  - apache-airflow>=2.9.0
-  - apache-airflow-providers-ssh>=2.1.0
-  - paramiko>=2.9.0
-  - asyncssh>=2.12.0
-
 integrations:
   - integration-name: SSH File Transfer Protocol (SFTP)
     external-doc-url: https://tools.ietf.org/wg/secsh/draft-ietf-secsh-filexfer/
-    logo: /integration-logos/sftp/SFTP.png
+    logo: /docs/integration-logos/SFTP.png
     tags: [protocol]
 
 operators:

docs/apache-airflow-providers-sftp/commits.rst renamed to providers/sftp/docs/commits.rst

@@ -0,0 +1,90 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+# NOTE! THIS FILE IS AUTOMATICALLY GENERATED AND WILL BE OVERWRITTEN!
+
+# IF YOU WANT TO MODIFY THIS FILE EXCEPT DEPENDENCIES, YOU SHOULD MODIFY THE TEMPLATE
+# `pyproject_TEMPLATE.toml.jinja2` IN the `dev/breeze/src/airflow_breeze/templates` DIRECTORY
+[build-system]
+requires = ["flit_core==3.10.1"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "apache-airflow-providers-sftp"
+version = "5.0.0"
+description = "Provider package apache-airflow-providers-sftp for Apache Airflow"
+readme = "README.rst"
+authors = [
+    {name="Apache Software Foundation", email="dev@airflow.apache.org"},
+]
+maintainers = [
+    {name="Apache Software Foundation", email="dev@airflow.apache.org"},
+]
+keywords = [ "airflow-provider", "sftp", "airflow", "integration" ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Framework :: Apache Airflow",
+    "Framework :: Apache Airflow :: Provider",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: System :: Monitoring",
+]
+requires-python = "~=3.9"
+
+# The dependencies should be modified in place in the generated file
+# Any change in the dependencies is preserved when the file is regenerated
+dependencies = [
+    "apache-airflow>=2.9.0",
+    "apache-airflow-providers-ssh>=2.1.0",
+    "paramiko>=2.9.0",
+    "asyncssh>=2.12.0",
+]
+
+# The optional dependencies should be modified in place in the generated file
+# Any change in the dependencies is preserved when the file is regenerated
+[project.optional-dependencies]
+"common.compat" = [
+    "apache-airflow-providers-common-compat"
+]
+"openlineage" = [
+    "apache-airflow-providers-openlineage"
+]
+
+[project.urls]
+"Documentation" = "https://airflow.apache.org/docs/apache-airflow-providers-sftp/5.0.0"
+"Changelog" = "https://airflow.apache.org/docs/apache-airflow-providers-sftp/5.0.0/changelog.html"
+"Bug Tracker" = "https://github.com/apache/airflow/issues"
+"Source Code" = "https://github.com/apache/airflow"
+"Slack Chat" = "https://s.apache.org/airflow-slack"
+"Twitter" = "https://x.com/ApacheAirflow"
+"YouTube" = "https://www.youtube.com/channel/UCSXwxpWZQ7XZ1WL3wqevChA/"
+
+[project.entry-points."apache_airflow_provider"]
+provider_info = "airflow.providers.sftp.get_provider_info:get_provider_info"
+
+[tool.flit.module]
+name = "airflow.providers.sftp"
+
+[tool.pytest.ini_options]
+ignore = "tests/system/"