oboladeras / pyftpclient

A Python-based FTP client for interacting with remote FTP servers.

PyFTPClient 🚀

This Python script provides a simple FTP client that allows you to connect to a remote FTP server, perform various file and directory operations, and run local shell commands. The client provides a command-line interface and supports a range of FTP commands for interacting with the remote server.

Usage 👨‍💻

To run the FTP client, execute the script using Python with the following command:

python3 PyFTPClient.py [IP] [port]

• IP: The IP address of the remote FTP server.
• port: (Optional) The port number to connect to the FTP server. The default port is 21.

Supported Commands ✅

• File Operations 📂:

  • ls: List files and directories on the remote FTP server.
  • cd: Change the current remote FTP directory.
  • pwd: Print the current remote FTP directory.
  • get: Download a file from the remote FTP server to the local machine.
  • put: Upload a local file to the remote FTP server.
  • rm: Remove a file from the remote FTP server.
  • mkdir: Create a directory on the remote FTP server.
  • rmdir: Remove a directory from the remote FTP server.

• FTP Transfer 📡:

  • passive: Switch between passive and active mode for FTP transfers.

• Permissions 🔒:

  • chmod: Change permission of a file on the remote FTP server.

• Renaming 🔧:

  • rename: Rename a file or directory on the remote FTP server.

• File Size 📏:

  • size: Retrieve the size of a file on the remote FTP server.

• Server Information ℹ️:

  • status: Get the status of the FTP server.

• File Display 📄:

  • open: Open and display the contents of a remote file.

• Other Commands 🛠️:

  • history: Display the command history.
  • local: Run a local shell command and print the output.
  • whoami: Print the username of the currently logged-in user.
  • source: Change the directory shown in the prompt (local or remote).
  • help: Print a help message.

To see a list of all the suported commands a descriptiond and a usage help, use the following command:

python3 PyFTPClient.py -h

Other Features: 🌟

• Tab-completion: The client supports tab-completion for commands and file/directory paths.
• Command History: The client keeps track of previously executed commands and allows you to access them using the up and down arrow keys.

Updates: 🆕

• Source command added, now is possible to display local cwd or remote cwd

([email protected])-[~]: source 
([email protected])-[~/projects/PyFTPClient]: 

• Progress bar added when download and upload files, also with file size and upload speed mesurements.

([email protected])-[~/projects/PyFTPClient]: put PyFTPClient.py
[==================================================] 100.00%  of 0.02 MB  [4.92 MB/s]         
File 'PyFTPClient.py' uploaded to '/home/server' in 0.01 seconds

• Ability to enter passive and active mode

([email protected])-[~]: passive?
Passive mode is enabled
([email protected])-[~]: passive
Passive mode disabled

• New commands
  - chmod
  - rename
  - size
  - status

Future Features

• Ability to stop downloads and uploads without restarting
• Tab update when working with directories

Dependencies 🛠️

This FTP client requires Python 3. The following libraries are used for various functionalities and are installed by default along with Python 3:

• os
• sys
• time
• ftplib
• getpass
• readline

No additional installation is required for these libraries.

Author ✍️

This FTP client is developed by OBoladeras and available on GitHub.

License 📄

This FTP client is released under the MIT License. Feel free to use and modify it as per your needs.

Note 📝

This FTP client is a basic implementation and may not cover all use cases or handle errors extensively. Use it at your discretion and ensure proper permissions and access rights for remote FTP operations.