| |downloads| |stars| |forks| |contributors| | |version| |packages| |license| | |github-actions| |doc| |twitter|
.. |downloads| image:: https://img.shields.io/pypi/dm/pyftpdlib.svg :target: https://pepy.tech/project/pyftpdlib :alt: Downloads
.. |stars| image:: https://img.shields.io/github/stars/giampaolo/pyftpdlib.svg :target: https://github.com/giampaolo/pyftpdlib/stargazers :alt: Github stars
.. |forks| image:: https://img.shields.io/github/forks/giampaolo/pyftpdlib.svg :target: https://github.com/giampaolo/pyftpdlib/network/members :alt: Github forks
.. |contributors| image:: https://img.shields.io/github/contributors/giampaolo/pyftpdlib.svg :target: https://github.com/giampaolo/pyftpdlib/graphs/contributors :alt: Contributors
.. |github-actions| image:: https://img.shields.io/github/actions/workflow/status/giampaolo/pyftpdlib/.github/workflows/tests.yml :target: https://github.com/giampaolo/pyftpdlib/actions :alt: GH actions
.. |doc| image:: https://readthedocs.org/projects/pyftpdlib/badge/?version=latest :target: https://pyftpdlib.readthedocs.io/en/latest/ :alt: Documentation Status
.. |version| image:: https://img.shields.io/pypi/v/pyftpdlib.svg?label=pypi :target: https://pypi.org/project/pyftpdlib :alt: Latest version
.. |py-versions| image:: https://img.shields.io/pypi/pyversions/psutil.svg :alt: Supported Python versions
.. |packages| image:: https://repology.org/badge/tiny-repos/python:pyftpdlib.svg :target: https://repology.org/metapackage/python:pyftpdlib/versions :alt: Binary packages
.. |license| image:: https://img.shields.io/github/license/giampaolo/pyftpdlib :target: https://github.com/giampaolo/pyftpdlib/blob/master/LICENSE :alt: License
.. |twitter| image:: https://img.shields.io/twitter/follow/grodola?style=flat :target: https://twitter.com/grodola :alt: Twitter Follow
Quick links ===========
Home_Documentation_Download_Mailing list_What's new_
Python FTP server library provides a high-level portable interface to easily
write very efficient, scalable and asynchronous FTP servers with Python. It is
the most complete RFC-959_ FTP server implementation available for the
Python_ programming language.
Features ========
- Extremely lightweight, fast and scalable (see
why __ and
benchmarks_).
- Uses sendfile(2) (see
pysendfile__)
- Uses `
epoll()/kqueue()/select()to handle concurrency
- ...But can optionally skip to a multiple thread / process
_ model (as in:
- Portable: entirely written in pure Python.
- Supports FTPS (RFC-4217
_), IPv6 (RFC-2428_), Unicode file
_), MLSD/MLST commands (RFC-3659_).
- Support for virtual users and virtual filesystem.
- Flexible system of "authorizers" able to manage both "virtual" and
"real" users on on both
UNIX __
and
Windows __.
Performance
===========
Despite being written in an interpreted language, pyftpdlib has transfer rates
comparable or superior to common UNIX FTP servers written in C. It usually
tends to scale better (see
benchmarks_) because whereas vsftpd and proftpd
use multiple processes to achieve concurrency, pyftpdlib only uses one (see
the C10K problem_).
pyftpdlib vs. proftpd 1.3.4
---------------------------
+-----------------------------------------+----------------+----------------+-------------+
| benchmark type | pyftpdlib | proftpd | speedup |
+-----------------------------------------+----------------+----------------+-------------+
| STOR (client -> server) | 585.90 MB/sec | 600.49 MB/sec | -0.02x |
+-----------------------------------------+----------------+----------------+-------------+
| RETR (server -> client) | 1652.72 MB/sec | 1524.05 MB/sec | +0.08 |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (connect, login) | 0.19 secs | 9.98 secs | +51x |
+-----------------------------------------+----------------+----------------+-------------+
| STOR (1 file with 300 idle clients) | 585.59 MB/sec | 518.55 MB/sec | +0.1x |
+-----------------------------------------+----------------+----------------+-------------+
| RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1478.19 MB/sec | 0x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.60 secs | +0.05x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (STOR 10M file) | 8.60 secs | 11.56 secs | +0.3x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (QUIT) | 0.03 secs | 0.39 secs | +12x |
+-----------------------------------------+----------------+----------------+-------------+
pyftpdlib vs. vsftpd 2.3.5
--------------------------
+-----------------------------------------+----------------+----------------+-------------+
| benchmark type | pyftpdlib | vsftpd | speedup |
+-----------------------------------------+----------------+----------------+-------------+
| STOR (client -> server) | 585.90 MB/sec | 611.73 MB/sec | -0.04x |
+-----------------------------------------+----------------+----------------+-------------+
| RETR (server -> client) | 1652.72 MB/sec | 1512.92 MB/sec | +0.09 |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (connect, login) | 0.19 secs | 20.39 secs | +106x |
+-----------------------------------------+----------------+----------------+-------------+
| STOR (1 file with 300 idle clients) | 585.59 MB/sec | 610.23 MB/sec | -0.04x |
+-----------------------------------------+----------------+----------------+-------------+
| RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1493.01 MB/sec | 0x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.67 secs | +0.07x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (STOR 10M file) | 8.60 secs | 9.82 secs | +0.07x |
+-----------------------------------------+----------------+----------------+-------------+
| 300 concurrent clients (QUIT) | 0.03 secs | 0.01 secs | +0.14x |
+-----------------------------------------+----------------+----------------+-------------+
For more benchmarks see
here __.
Command line usage
==================
Start an anonymous FTP server on port 2121:
.. code-block:: sh
$ python3 -m pyftpdlib
[I 2024-06-23 13:49:35] >>> starting FTP server on 0.0.0.0:2121, pid=763634 <<<
Same but with write permissions (useful to setup a quick and dirty file sharing server):
.. code-block:: sh
$ python3 -m pyftpdlib --write
[I 2024-06-23 13:49:35] >>> starting FTP server on 0.0.0.0:2121, pid=763641 <<<
Also see
CLI doc __
for more command line examples.
API usage
=========
.. code-block:: python
>>> from pyftpdlib.authorizers import DummyAuthorizer
>>> from pyftpdlib.handlers import FTPHandler
>>> from pyftpdlib.servers import FTPServer
>>>
>>> authorizer = DummyAuthorizer()
>>> authorizer.add_user("user", "12345", "/home/giampaolo", perm="elradfmwMT")
>>> authorizer.add_anonymous("/home/nobody")
>>>
>>> handler = FTPHandler
>>> handler.authorizer = authorizer
>>>
>>> server = FTPServer(("127.0.0.1", 21), handler)
>>> server.serve_forever()
[I 13-02-19 10:55:42] >>> starting FTP server on 127.0.0.1:21 <<<
[I 13-02-19 10:55:42] poller:
[I 13-02-19 10:55:42] masquerade (NAT) address: None
[I 13-02-19 10:55:42] passive ports: None
[I 13-02-19 10:55:42] use sendfile(2): True
[I 13-02-19 10:55:45] 127.0.0.1:34178-[] FTP session opened (connect)
[I 13-02-19 10:55:48] 127.0.0.1:34178-[user] USER 'user' logged in.
[I 13-02-19 10:56:27] 127.0.0.1:34179-[user] RETR /home/giampaolo/.vimrc completed=1 bytes=1700 seconds=0.001
[I 13-02-19 10:56:39] 127.0.0.1:34179-[user] FTP session closed (disconnect).
For other code samples read the
tutorial __
Donate
======
A lot of time and effort went into making pyftpdlib as it is right now.
If you feel pyftpdlib is useful to you or your business and want to support its
future development please consider
donating_ me some money.
.. _
benchmarks: https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html
.. _Documentation: https://pyftpdlib.readthedocs.io
.. _donating: https://gmpy.dev/donate
.. _Download: https://pypi.org/project/pyftpdlib/
.. _Home: https://github.com/giampaolo/pyftpdlib
.. _Mailing list: https://groups.google.com/group/pyftpdlib/topics
.. _multiple thread / process: https://pyftpdlib.readthedocs.io/en/latest/tutorial.html#changing-the-concurrency-model
.. _Python: https://www.python.org/
.. _RFC-2428: https://datatracker.ietf.org/doc/html/rfc2428
.. _RFC-2640: https://datatracker.ietf.org/doc/html/rfc2640
.. _RFC-3659: https://datatracker.ietf.org/doc/html/rfc3659
.. _RFC-4217: https://datatracker.ietf.org/doc/html/rfc4217
.. _RFC-959: https://datatracker.ietf.org/doc/html/rfc959.html
.. _the C10K problem: http://www.kegel.com/c10k.html
.. _What's new`: https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst