| |downloads| |stars| |forks| |contributors| |coverage|
| |version| |packages| |license|
| |github-actions| |appveyor| |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
.. |appveyor| image:: https://img.shields.io/appveyor/build/giampaolo/pyftpdlib/master.svg?maxAge=3600&label=Windows%20(py2)
:target: https://ci.appveyor.com/project/giampaolo/pyftpdlib
:alt: Windows (Py2, Windows)
.. |coverage| image:: https://img.shields.io/codecov/c/github/giampaolo/pyftpdlib/update-ci?label=coverage
:target: https://codecov.io/gh/giampaolo/pyftpdlib
:alt: Test coverage
.. |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/pypi/l/pyftpdlib.svg
:target: https://github.com/giampaolo/pyftpdlib/blob/master/LICENSE
:alt: License
.. |twitter| image:: https://img.shields.io/twitter/follow/grodola.svg?label=follow&style=flat&logo=twitter&logoColor=4FADFF
:target: https://twitter.com/grodola
:alt: Twitter Follow
Quick links
===========
- `Home <https://github.com/giampaolo/pyftpdlib>`__
- `Documentation <http://pyftpdlib.readthedocs.io>`__
- `Download <https://pypi.python.org/pypi/pyftpdlib/>`__
- `Blog <http://grodola.blogspot.com/search/label/pyftpdlib>`__
- `Mailing list <http://groups.google.com/group/pyftpdlib/topics>`__
- `What's new <https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst>`__
About
=====
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 <http://www.faqs.org/rfcs/rfc959.html>`__ FTP server
implementation available for `Python <http://www.python.org/>`__ programming
language.
Features
========
- Extremely **lightweight**, **fast** and **scalable** (see
`why <https://github.com/giampaolo/pyftpdlib/issues/203>`__ and
`benchmarks <http://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__).
- Uses **sendfile(2)** (see `pysendfile <https://github.com/giampaolo/pysendfile>`__)
system call for uploads.
- Uses epoll() / kqueue() / select() to handle concurrency asynchronously.
- ...But can optionally skip to a
`multiple thread / process <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#changing-the-concurrency-model>`__
model (as in: you'll be free to block or use slow filesystems).
- Portable: entirely written in pure Python; works with Python **2.7** and
**3.X** using a single code base.
- Supports **FTPS** (`RFC-4217 <http://tools.ietf.org/html/rfc4217>`__),
**IPv6** (`RFC-2428 <ftp://ftp.rfc-editor.org/in-notes/rfc2428.txt>`__),
**Unicode** file names (`RFC-2640 <http://tools.ietf.org/html/rfc2640>`__),
**MLSD/MLST** commands (`RFC-3659 <ftp://ftp.rfc-editor.org/in-notes/rfc3659.txt>`__).
- Support for virtual users and virtual filesystem.
- Flexible system of "authorizers" able to manage both "virtual" and
"real" users on on both
`UNIX <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#unix-ftp-server>`__
and
`Windows <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#windows-ftp-server>`__.
Performances
============
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 <https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__)
because whereas vsftpd and proftpd use multiple processes to
achieve concurrency, pyftpdlib only uses one (see `the C10K problem <http://www.kegel.com/c10k.html>`__).
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 <http://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__.
Quick start
===========
.. 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: <class 'pyftpdlib.ioloop.Epoll'>
[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).
`other code samples <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html>`__
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 <https://gmpy.dev/donate>`__ me some money.
Raw data
{
"_id": null,
"home_page": "https://github.com/giampaolo/pyftpdlib/",
"name": "pyftpdlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ftp,ftps,server,ftpd,daemon,python,ssl,sendfile,asynchronous,nonblocking,eventdriven,rfc959,rfc1123,rfc2228,rfc2428,rfc2640,rfc3659",
"author": "Giampaolo Rodola'",
"author_email": "g.rodola@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/47/9f/5dc055ab2db58db561f72b1b2f18b1dafc025f2ac5dd842c40259c17195e/pyftpdlib-1.5.9.tar.gz",
"platform": "Platform Independent",
"description": "| |downloads| |stars| |forks| |contributors| |coverage|\n| |version| |packages| |license|\n| |github-actions| |appveyor| |doc| |twitter|\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/pyftpdlib.svg\n :target: https://pepy.tech/project/pyftpdlib\n :alt: Downloads\n\n.. |stars| image:: https://img.shields.io/github/stars/giampaolo/pyftpdlib.svg\n :target: https://github.com/giampaolo/pyftpdlib/stargazers\n :alt: Github stars\n\n.. |forks| image:: https://img.shields.io/github/forks/giampaolo/pyftpdlib.svg\n :target: https://github.com/giampaolo/pyftpdlib/network/members\n :alt: Github forks\n\n.. |contributors| image:: https://img.shields.io/github/contributors/giampaolo/pyftpdlib.svg\n :target: https://github.com/giampaolo/pyftpdlib/graphs/contributors\n :alt: Contributors\n\n.. |github-actions| image:: https://img.shields.io/github/actions/workflow/status/giampaolo/pyftpdlib/.github/workflows/tests.yml\n :target: https://github.com/giampaolo/pyftpdlib/actions\n :alt: GH actions\n\n.. |appveyor| image:: https://img.shields.io/appveyor/build/giampaolo/pyftpdlib/master.svg?maxAge=3600&label=Windows%20(py2)\n :target: https://ci.appveyor.com/project/giampaolo/pyftpdlib\n :alt: Windows (Py2, Windows)\n\n.. |coverage| image:: https://img.shields.io/codecov/c/github/giampaolo/pyftpdlib/update-ci?label=coverage\n :target: https://codecov.io/gh/giampaolo/pyftpdlib\n :alt: Test coverage\n\n.. |doc| image:: https://readthedocs.org/projects/pyftpdlib/badge/?version=latest\n :target: https://pyftpdlib.readthedocs.io/en/latest/\n :alt: Documentation Status\n\n.. |version| image:: https://img.shields.io/pypi/v/pyftpdlib.svg?label=pypi\n :target: https://pypi.org/project/pyftpdlib\n :alt: Latest version\n\n.. |py-versions| image:: https://img.shields.io/pypi/pyversions/psutil.svg\n :alt: Supported Python versions\n\n.. |packages| image:: https://repology.org/badge/tiny-repos/python:pyftpdlib.svg\n :target: https://repology.org/metapackage/python:pyftpdlib/versions\n :alt: Binary packages\n\n.. |license| image:: https://img.shields.io/pypi/l/pyftpdlib.svg\n :target: https://github.com/giampaolo/pyftpdlib/blob/master/LICENSE\n :alt: License\n\n.. |twitter| image:: https://img.shields.io/twitter/follow/grodola.svg?label=follow&style=flat&logo=twitter&logoColor=4FADFF\n :target: https://twitter.com/grodola\n :alt: Twitter Follow\n\nQuick links\n===========\n\n- `Home <https://github.com/giampaolo/pyftpdlib>`__\n- `Documentation <http://pyftpdlib.readthedocs.io>`__\n- `Download <https://pypi.python.org/pypi/pyftpdlib/>`__\n- `Blog <http://grodola.blogspot.com/search/label/pyftpdlib>`__\n- `Mailing list <http://groups.google.com/group/pyftpdlib/topics>`__\n- `What's new <https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst>`__\n\nAbout\n=====\n\nPython FTP server library provides a high-level portable interface to easily\nwrite very efficient, scalable and asynchronous FTP servers with Python. It is\nthe most complete `RFC-959 <http://www.faqs.org/rfcs/rfc959.html>`__ FTP server\nimplementation available for `Python <http://www.python.org/>`__ programming\nlanguage.\n\nFeatures\n========\n\n- Extremely **lightweight**, **fast** and **scalable** (see\n `why <https://github.com/giampaolo/pyftpdlib/issues/203>`__ and\n `benchmarks <http://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__).\n- Uses **sendfile(2)** (see `pysendfile <https://github.com/giampaolo/pysendfile>`__)\n system call for uploads.\n- Uses epoll() / kqueue() / select() to handle concurrency asynchronously.\n- ...But can optionally skip to a\n `multiple thread / process <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#changing-the-concurrency-model>`__\n model (as in: you'll be free to block or use slow filesystems).\n- Portable: entirely written in pure Python; works with Python **2.7** and\n **3.X** using a single code base.\n- Supports **FTPS** (`RFC-4217 <http://tools.ietf.org/html/rfc4217>`__),\n **IPv6** (`RFC-2428 <ftp://ftp.rfc-editor.org/in-notes/rfc2428.txt>`__),\n **Unicode** file names (`RFC-2640 <http://tools.ietf.org/html/rfc2640>`__),\n **MLSD/MLST** commands (`RFC-3659 <ftp://ftp.rfc-editor.org/in-notes/rfc3659.txt>`__).\n- Support for virtual users and virtual filesystem.\n- Flexible system of \"authorizers\" able to manage both \"virtual\" and\n \"real\" users on on both\n `UNIX <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#unix-ftp-server>`__\n and\n `Windows <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html#windows-ftp-server>`__.\n\nPerformances\n============\n\nDespite being written in an interpreted language, pyftpdlib has transfer rates\ncomparable or superior to common UNIX FTP servers written in C. It usually tends\nto scale better (see `benchmarks <https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__)\nbecause whereas vsftpd and proftpd use multiple processes to\nachieve concurrency, pyftpdlib only uses one (see `the C10K problem <http://www.kegel.com/c10k.html>`__).\n\npyftpdlib vs. proftpd 1.3.4\n---------------------------\n\n+-----------------------------------------+----------------+----------------+-------------+\n| **benchmark type** | **pyftpdlib** | **proftpd** | **speedup** |\n+-----------------------------------------+----------------+----------------+-------------+\n| STOR (client -> server) | 585.90 MB/sec | 600.49 MB/sec | -0.02x |\n+-----------------------------------------+----------------+----------------+-------------+\n| RETR (server -> client) | 1652.72 MB/sec | 1524.05 MB/sec | **+0.08** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (connect, login) | 0.19 secs | 9.98 secs | **+51x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| STOR (1 file with 300 idle clients) | 585.59 MB/sec | 518.55 MB/sec | **+0.1x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1478.19 MB/sec | 0x |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.60 secs | **+0.05x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (STOR 10M file) | 8.60 secs | 11.56 secs | **+0.3x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (QUIT) | 0.03 secs | 0.39 secs | **+12x** |\n+-----------------------------------------+----------------+----------------+-------------+\n\npyftpdlib vs. vsftpd 2.3.5\n--------------------------\n\n+-----------------------------------------+----------------+----------------+-------------+\n| **benchmark type** | **pyftpdlib** | **vsftpd** | **speedup** |\n+-----------------------------------------+----------------+----------------+-------------+\n| STOR (client -> server) | 585.90 MB/sec | 611.73 MB/sec | -0.04x |\n+-----------------------------------------+----------------+----------------+-------------+\n| RETR (server -> client) | 1652.72 MB/sec | 1512.92 MB/sec | **+0.09** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (connect, login) | 0.19 secs | 20.39 secs | **+106x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| STOR (1 file with 300 idle clients) | 585.59 MB/sec | 610.23 MB/sec | -0.04x |\n+-----------------------------------------+----------------+----------------+-------------+\n| RETR (1 file with 300 idle clients) | 1497.58 MB/sec | 1493.01 MB/sec | 0x |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (RETR 10M file) | 3.41 secs | 3.67 secs | **+0.07x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (STOR 10M file) | 8.60 secs | 9.82 secs | **+0.07x** |\n+-----------------------------------------+----------------+----------------+-------------+\n| 300 concurrent clients (QUIT) | 0.03 secs | 0.01 secs | +0.14x |\n+-----------------------------------------+----------------+----------------+-------------+\n\nFor more benchmarks see `here <http://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__.\n\nQuick start\n===========\n\n.. code-block:: python\n\n >>> from pyftpdlib.authorizers import DummyAuthorizer\n >>> from pyftpdlib.handlers import FTPHandler\n >>> from pyftpdlib.servers import FTPServer\n >>>\n >>> authorizer = DummyAuthorizer()\n >>> authorizer.add_user(\"user\", \"12345\", \"/home/giampaolo\", perm=\"elradfmwMT\")\n >>> authorizer.add_anonymous(\"/home/nobody\")\n >>>\n >>> handler = FTPHandler\n >>> handler.authorizer = authorizer\n >>>\n >>> server = FTPServer((\"127.0.0.1\", 21), handler)\n >>> server.serve_forever()\n [I 13-02-19 10:55:42] >>> starting FTP server on 127.0.0.1:21 <<<\n [I 13-02-19 10:55:42] poller: <class 'pyftpdlib.ioloop.Epoll'>\n [I 13-02-19 10:55:42] masquerade (NAT) address: None\n [I 13-02-19 10:55:42] passive ports: None\n [I 13-02-19 10:55:42] use sendfile(2): True\n [I 13-02-19 10:55:45] 127.0.0.1:34178-[] FTP session opened (connect)\n [I 13-02-19 10:55:48] 127.0.0.1:34178-[user] USER 'user' logged in.\n [I 13-02-19 10:56:27] 127.0.0.1:34179-[user] RETR /home/giampaolo/.vimrc completed=1 bytes=1700 seconds=0.001\n [I 13-02-19 10:56:39] 127.0.0.1:34179-[user] FTP session closed (disconnect).\n\n`other code samples <http://pyftpdlib.readthedocs.io/en/latest/tutorial.html>`__\n\nDonate\n======\n\nA lot of time and effort went into making pyftpdlib as it is right now.\nIf you feel pyftpdlib is useful to you or your business and want to support its\nfuture development please consider `donating <https://gmpy.dev/donate>`__ me some money.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Very fast asynchronous FTP server library",
"version": "1.5.9",
"project_urls": {
"Homepage": "https://github.com/giampaolo/pyftpdlib/"
},
"split_keywords": [
"ftp",
"ftps",
"server",
"ftpd",
"daemon",
"python",
"ssl",
"sendfile",
"asynchronous",
"nonblocking",
"eventdriven",
"rfc959",
"rfc1123",
"rfc2228",
"rfc2428",
"rfc2640",
"rfc3659"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "479f5dc055ab2db58db561f72b1b2f18b1dafc025f2ac5dd842c40259c17195e",
"md5": "cb32bca52ba0d4850a92513154c253e1",
"sha256": "323d4c42f1406aedb4df18faf680f64f32c080ff66f6c26090ba592f5bfc4a0f"
},
"downloads": -1,
"filename": "pyftpdlib-1.5.9.tar.gz",
"has_sig": false,
"md5_digest": "cb32bca52ba0d4850a92513154c253e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 204755,
"upload_time": "2023-10-25T21:11:31",
"upload_time_iso_8601": "2023-10-25T21:11:31.189415Z",
"url": "https://files.pythonhosted.org/packages/47/9f/5dc055ab2db58db561f72b1b2f18b1dafc025f2ac5dd842c40259c17195e/pyftpdlib-1.5.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-25 21:11:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "giampaolo",
"github_project": "pyftpdlib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"appveyor": true,
"lcname": "pyftpdlib"
}
JSON
