From 89ca5bc8e31095f4c9e8bdf851557e41c6364122 Mon Sep 17 00:00:00 2001 From: Josh Schneier Date: Sun, 3 Sep 2023 13:22:23 -0400 Subject: [PATCH] [s3] add s3 extras_require (#1284) --- docs/backends/amazon-S3.rst | 13 +++++++------ setup.cfg | 2 ++ 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/backends/amazon-S3.rst b/docs/backends/amazon-S3.rst index 9775abf2..ee52e976 100644 --- 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 index e916cd0c..9bf06299 100644 --- 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 =