[s3] add s3 extras_require (#1284)

jschneier · Sep 3, 2023 · 89ca5bc · 89ca5bc
1 parent 53d6675
commit 89ca5bc
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/docs/backends/amazon-S3.rst b/docs/backends/amazon-S3.rst
@@ -1,14 +1,15 @@
 Amazon S3
 =========
 
-Usage
-*****
+This backend implements the Django File Storage API for Amazon Web Services's (AWS) Simple Storage Service (S3).
 
-There is only one supported backend for interacting with Amazon's S3,
-``S3Boto3Storage``, based on the boto3 library.
+Installation
+------------
 
-The minimum required version of ``boto3`` is 1.4.4 although we always recommend
-the most recent.
+The backend is based on the boto3 library which must be installed; the minimum required version is 1.4.4 although
+we always recommend the most recent. Either add it to your requirements or use the optional ``s3`` extra e.g::
+
+  pip install django-storages[s3]
 
 Settings
 --------

diff --git a/setup.cfg b/setup.cfg
@@ -48,6 +48,8 @@ libcloud =
     apache-libcloud
 sftp =
     paramiko >= 1.15.0
+s3 =
+    boto3 >= 1.4.4
 
 [flake8]
 exclude =