fileshiftlib 0.0.1__py3-none-any.whl

fileshiftlib/__init__.py

@@ -0,0 +1,3 @@
+from .fileshift import SFTP
+
+__all__ = ["SFTP"]

fileshiftlib/__main__.py

@@ -0,0 +1,7 @@
+from .fileshift import SFTP
+
+def main():
+    print("SFTP client Python package that uses paramiko library.")
+
+if __name__ == "__main__":
+    main()

fileshiftlib/fileshift.py

@@ -0,0 +1,135 @@
+from dataclasses import dataclass
+import logging
+import paramiko
+
+
+class SFTP(object):
+    @dataclass
+    class Configuration:
+        host: str = None
+        port: int = None
+        username: str = None
+        password: str = None
+
+    def __init__(self, host: str, username: str, password: str, port: int = 22) -> None:
+        """
+        Initializes the SFTP client with the given configuration and authenticates.
+
+        Args:
+            host (str): The hostname of the SFTP server.
+            username (str): The username for authentication.
+            password (str): The password for authentication.
+            port (int, optional): The port number of the SFTP server. Defaults to 22.
+        """
+        # Init logging
+        self.__logger = logging.getLogger(name=__name__)
+        self.__logger.setLevel(level=logging.INFO)
+        handler = logging.StreamHandler()
+        self.__logger.addHandler(handler)
+
+        # Credentials/configuration
+        self.sftp_client: paramiko.sftp_client.SFTPClient = None
+        self.__transport: paramiko.transport.Transport = None
+
+        port = 22 if port is None else port
+        self.__configuration = self.Configuration(host=host,
+                                                  port=port,
+                                                  username=username,
+                                                  password=password)
+
+        # Authenticate
+        self.__transport, self.sftp_client = self.auth()
+
+    def __del__(self) -> None:
+        """
+        Destructor to clean up the SFTP client and close the transport session.
+        """
+        self.__logger.info(msg="Closes session")
+
+        self.__transport.close()
+        self.sftp_client.close()
+
+    def auth(self) -> tuple:
+        """
+        Authenticates with the SFTP server and initializes the SFTP client.
+
+        Returns:
+            tuple: A tuple containing the transport and SFTP client objects.
+        """
+        self.__logger.info(msg="Opens session")
+
+        # Connect
+        transport = paramiko.Transport((self.__configuration.host, self.__configuration.port))
+        transport.connect(username=self.__configuration.username, password=self.__configuration.password)
+        sftp_client = paramiko.SFTPClient.from_transport(transport)
+        
+        return transport, sftp_client
+    
+    def list_dir(self, path: str = ".") -> list:
+        """
+        Lists the names of the contents in the specified folder on the SFTP server.
+
+        Args:
+            path (str, optional): The path to the folder on the SFTP server. Defaults to the current directory.
+
+        Returns:
+            list: A list of names of the contents in the specified folder.
+        """
+        self.__logger.info(msg="Lists the names of the contents in the specified folder")
+        self.__logger.info(msg=path)
+
+        return self.sftp_client.listdir(path)
+
+    def change_dir(self, path: str = ".") -> None:
+        """
+        Changes the current working directory on the SFTP server.
+
+        Args:
+            path (str, optional): The path to the folder to change to on the SFTP server. Defaults to the current directory.
+        """
+        self.__logger.info(msg="Changes the current working directory")
+        self.__logger.info(msg=path)
+
+        self.sftp_client.chdir(path)
+
+    def delete_file(self, filename: str) -> None:
+        """
+        Deletes a file on the SFTP server.
+
+        Args:
+            filename (str): The name of the file to delete on the SFTP server.
+        """
+        self.__logger.info(msg="Deletes a file")
+        self.__logger.info(msg=filename)
+
+        self.sftp_client.remove(filename)
+
+    def download_file(self, remote_path: str, local_path: str) -> None:
+        """
+        Downloads a file from the SFTP server to the local machine.
+
+        Args:
+            remote_path (str): The path to the file on the SFTP server.
+            local_path (str): The path on the local machine where the file will be saved.
+        """
+        self.__logger.info(msg="Downloads a file from the SFTP server to the local machine")
+        self.__logger.info(msg=remote_path)
+        self.__logger.info(msg=local_path)
+
+        self.sftp_client.get(remote_path, local_path)
+
+    def upload_file(self, local_path: str, remote_path: str) -> None:
+        """
+        Uploads a file from the local machine to the SFTP server.
+
+        Args:
+            local_path (str): The path to the file on the local machine.
+            remote_path (str): The path on the SFTP server where the file will be saved.
+        """
+        self.__logger.info(msg="Uploads a file from the local machine to the SFTP")
+        self.__logger.info(msg=local_path)
+        self.__logger.info(msg=remote_path)
+
+        self.sftp_client.put(local_path, remote_path)
+
+# eom

fileshiftlib-0.0.1.dist-info/METADATA

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: fileshiftlib
+Version: 0.0.1
+Summary: SFTP client!
+Author-email: Paulo Portela <portela.paulo@gmail.com>
+Maintainer-email: Paulo Portela <portela.paulo@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/aghuttun/fileshiftlib
+Project-URL: Documentation, https://github.com/aghuttun/fileshiftlib/blob/main/README.md
+Keywords: SFTP,Python,FTP,File Transfer
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: MacOS :: MacOS X
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: paramiko>=3.0
+Dynamic: license-file
+
+# fileshiftlib
+
+* [Description](#package-description)
+* [Usage](#usage)
+* [Installation](#installation)
+* [License](#license)
+
+## Package Description
+
+SFTP client Python package that uses [paramiko](https://pypi.org/project/paramiko/) library.
+
+## Usage
+
+* [fileshiftlib](#fileshiftlib)
+
+from a script:
+
+```python
+import fileshiftlib
+import logging
+
+logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
+
+host = "localhost"
+username = "123..."
+password = "xxxx"
+port = 22
+
+# Initialize SFTP client
+sftp = fileshiftlib.SFTP(host=host,
+                         username=username,
+                         password=password,
+                         port=port)
+```
+
+## Installation
+
+* [fileshiftlib](#fileshiftlib)
+
+Install python and pip if you have not already.
+
+Then run:
+
+```bash
+pip3 install pip --upgrade
+pip3 install wheel
+```
+
+For production:
+
+```bash
+pip3 install fileshiftlib
+```
+
+This will install the package and all of it's python dependencies.
+
+If you want to install the project for development:
+
+```bash
+git clone https://github.com/aghuttun/fileshiftlib.git
+cd fileshiftlib
+pip3 install -e .[dev]
+```
+
+To test the development package: [Testing](#testing)
+
+## License
+
+* [fileshiftlib](#fileshiftlib)
+
+BSD License (see license file)

fileshiftlib-0.0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+fileshiftlib/__init__.py,sha256=i9ClLZboHHUkM_4-TAp8WjxWn25joiLKmx-XoZzSug8,51
+fileshiftlib/__main__.py,sha256=usjroUuPKq8yvL8KYJC_T9QPqbwWGVFBv1SUl-pmI1g,155
+fileshiftlib/fileshift.py,sha256=suEIK-ZC9WY-kilQTQDdf8Sswvecx_MiFtdRaAl3kiI,4951
+fileshiftlib-0.0.1.dist-info/licenses/LICENSE.txt,sha256=18KXUvbHORa48k6axcyPfIqUhl6vo3nQglZA8jSRHVA,1473
+fileshiftlib-0.0.1.dist-info/METADATA,sha256=7LEx5VYaNf2dhpt0l90YvbYU8fC7uodfBc83pBxeKb0,2301
+fileshiftlib-0.0.1.dist-info/WHEEL,sha256=0CuiUZ_p9E4cD6NyLD6UG80LBXYyiSYZOKDm5lp32xk,91
+fileshiftlib-0.0.1.dist-info/top_level.txt,sha256=HUWlxFzXEsJRxW5PRN_2rxyjiuPjQQTlY26h_x8kFFI,13
+fileshiftlib-0.0.1.dist-info/RECORD,,

fileshiftlib-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.3.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fileshiftlib-0.0.1.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,11 @@
+Copyright 2025 Paulo Portela
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

fileshiftlib-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+fileshiftlib