Python库 | django-s3-file-upload-0.0.6.tar.gz

Django S3 File Upload Server =================== [](https://travis-ci.com/dabapps/django-s3-file-upload-server) [](https://pypi.python.org/pypi/django-s3-file-upload) Upload files from the browser to S3 - server side implementation For the client side implementation see [github.com/dabapps/django-s3-file-upload-client](https://github.com/dabapps/django-s3-file-upload-client) ## Getting Started ### Installation Add the following to `requirement.txt` django-s3-file-upload Add the following to `settings.py` INSTALLED_APPS = ( ... 's3_file_uploads', ... ) ... # S3 AWS_BUCKET_NAME = env('S3_BUCKET_NAME') AWS_STORAGE_BUCKET_NAME = AWS_BUCKET_NAME AWS_ACCESS_KEY_ID = env('AWS_ACCESS_KEY_ID') AWS_SECRET_ACCESS_KEY = env('AWS_SECRET_ACCESS_KEY') **Please make sure to** - **set a `MAX_FILE_UPLOAD_SIZE` in `settings.py`.** - **run migrations to create the `UploadedFile` table in your database.** ### Setup environment variables You will need to create an AWS bucket and set the following env variables ``` AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY S3_BUCKET_NAME ``` ## Usage The flow to be able to upload files from the browser straight to AWS is as follows.  This repo will give you access to some useful enpoints. To make these endpoints available, add the following to the `urlpatterns` ``` url(r'^s3-file-uploads/', view=include('s3_file_uploads.urls')) ``` This will give you access to - POST `/s3-file-uploads/` for getting a url to upload files to AWS to - POST `/s3-file-uploads/<file_id>/complete/` for marking an upload as complete - GET `/s3-file-uploads/<file_id>/` for getting an AWS endpoint to download files from Hitting these endpoints will `create`, `update` and `retrieve` instances of `UploadedFile` under the hood. **Please note that meta data can optionally be passed in at the initial post request, such as `file_key` and `filename` and the `acl` type which will define the access control in S3.** The possible `acl` types are (with the default as `private` if none are passed in the request data): ``` PRIVATE = 'private' PUBLIC_READ = 'public-read' PUBLIC_READ_WRITE = 'public-read-write' AUTHENTICATED_READ = 'authenticated-read' ``` For an abstraction of the client side implementation of uploading a file from the browser straight to S3, see [github.com/dabapps/django-s3-file-upload-client](https://github.com/dabapps/django-s3-file-upload-client) ## Examples Now that we have the table `UploadedFile` available to us, which stores an `id`, `file_key`, `filename`, `file_upload_state` and the `user` that requested the file upload, we might want to link this to a model in our project as follows. ``` from django.db import models from s3_file_uploads.models import UploadedFile class Llama(models.Model): file = models.OneToOneField( UploadedFile, on_delete=models.CASCADE ) ``` Now we could setup some endpoints to `create/update` a `Llama` instance for example. If needed, you can import a util `UploadedFilePrimaryKeyRelatedField ` from `s3_file_uploads.fields`. This may be used in the create serializer for your endpoint to ensure only users that have uploaded the file are able to assign this to a custom model. After a file has been uploaded to S3 by the client, the frontend will have the `file_id` and could use this to `create/update` the `Llama` instance. ### Downloading a file As noted above in the list of available endpoints, we can do a GET request to`/s3-file-uploads/<file_id>/` to get the AWS endpoint to download a file from. This endpoint is useful when the frontend knows the `file_id` and wants to retreive a single file. We might also want to setup an endpoint to retrieve all `Llama` data and include the download url for the `file`. Say we have an instance of `Llama` called `llama`. All we need to do is call the model method `llama.get_download_url()` or `llama.get_view_url()` which returns the S3 url including access keys where the file can be downloaded or viewed from. Then the serializer could return the `download_url` or `view_url` to the frontend. ## Code of conduct For guidelines regarding the code of conduct when contributing to this repository please review [https://www.dabapps.com/open-source/code-of-conduct/](https://www.dabapps.com/open-source/code-of-conduct/)