thinFTP Documentation

A minimal, lightweight FTP server implementation in Python.

Note

thinFTP is designed to be a simple, educational FTP server. It’s perfect for learning about FTP protocols or for lightweight development scenarios.

Quick Start

Install thinFTP:

pip install thinftp

Run the server:

thinftp --bind localhost --port 2121 --user testuser

Or programmatically:

from thinftp.server import start_server
from thinftp.logger import get_logger
from argparse import Namespace

config = Namespace(
    bind='localhost', port=2121, user='anonymous',
    pswd='', directory='.', lgr=get_logger()
)
start_server(config)

Features

• 🚀 Lightweight: Minimal dependencies and footprint

• 📝 Well-documented: Comprehensive documentation with examples

• 🔧 Configurable: Easy to customize and extend

• 🐍 Pure Python: No external dependencies required

• 📋 FTP Compliant: Implements standard FTP protocol

Table of Contents

User Guide

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Development Installation
  • Verify Installation
• Quick Start Guide
  • Basic Usage
  • Command Line Usage
  • Connecting to the Server
  • Basic Configuration
  • Stopping the Server
• Configuration
  • Basic Configuration
  • Logging Configuration
  • Security Considerations
• Examples
  • Basic FTP Server
  • Custom Root Directory
  • With Custom Logging
  • Command Line Examples

API Reference

• Server Module
  • ThreadedThinFTP
  • start_server()
  • ThreadedThinFTP Class
• Handler Module
  • ThinFTP
  • ThinFTP Class
• File Manager Module
  • FileHandler
• Logger Module
  • success()
  • Formatter
  • get_logger()
• Errors Module
  • ClientQuit
  • FileHandlerError

Development

• Contributing
• Changelog

Indices and tables

• Index

• Module Index

• Search Page