Skip to content

Commit

Permalink
update link refs
Browse files Browse the repository at this point in the history
  • Loading branch information
giampaolo committed Sep 16, 2024
1 parent 48aeef3 commit a496220
Showing 1 changed file with 36 additions and 23 deletions.
59 changes: 36 additions & 23 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,38 +48,35 @@
Quick links
===========

- `Home <https://github.com/giampaolo/pyftpdlib>`__
- `Documentation <https://pyftpdlib.readthedocs.io>`__
- `Download <https://pypi.org/project/pyftpdlib/>`__
- `Mailing list <https://groups.google.com/group/pyftpdlib/topics>`__
- `What's new <https://github.com/giampaolo/pyftpdlib/blob/master/HISTORY.rst>`__
- `Home`_
- `Documentation`_
- `Download`_
- `Mailing list`_
- `What's new`_

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 <https://datatracker.ietf.org/doc/html/rfc959.html>`__ FTP server
implementation available for `Python <https://www.python.org/>`__ programming
language.
the most complete `RFC-959`_ FTP server implementation available for `Python`_
programming language.

Features
========

- Extremely **lightweight**, **fast** and **scalable** (see
`why <https://github.com/giampaolo/pyftpdlib/issues/203>`__ and
`benchmarks <https://pyftpdlib.readthedocs.io/en/latest/benchmarks.html>`__).
`benchmarks`__).
- Uses **sendfile(2)** (see `pysendfile <https://github.com/giampaolo/pysendfile>`__)
system call for uploads (Linux only).
- Uses epoll() / kqueue() / select() to handle concurrency asynchronously.
- ...But can optionally skip to a
`multiple thread / process <https://pyftpdlib.readthedocs.io/en/latest/tutorial.html#changing-the-concurrency-model>`__
model (as in: you'll be free to block or use slow filesystems).
- Uses ``epoll()`` / ``kqueue()`` / ``select()`` to handle concurrency
asynchronously.
- ...But can optionally skip to a `multiple thread / process`_ model (as in:
you'll be free to block or use slow filesystems).
- Portable: entirely written in pure Python.
- Supports **FTPS** (`RFC-4217 <https://datatracker.ietf.org/doc/html/rfc4217>`__),
**IPv6** (`RFC-2428 <https://datatracker.ietf.org/doc/html/rfc2428>`__),
**Unicode** file names (`RFC-2640 <https://datatracker.ietf.org/doc/html/rfc2640>`__),
**MLSD/MLST** commands (`RFC-3659 <https://datatracker.ietf.org/doc/html/rfc3659>`__).
- Supports **FTPS** (`RFC-4217`_), **IPv6** (`RFC-2428`_), **Unicode** file
names (`RFC-2640`_), **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
Expand All @@ -91,10 +88,10 @@ 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>`__).
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
---------------------------
Expand Down Expand Up @@ -187,11 +184,27 @@ API usage
[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 <https://pyftpdlib.readthedocs.io/en/latest/tutorial.html>`__
For other code samples read the `tutorial <https://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.
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

0 comments on commit a496220

Please sign in to comment.