joist

Joist是一个Django小部件库，通过浏览器直接上传到S3桶，而不是通过服务器。它扩展了django-storages库的S3文件存储功能

安装

pip install django-storages joist

通过源码

pip install -e 'git+https://github.com/danlamanna/joist.git#egg=joist'

配置

Joist依赖于django-storages的S3配置（参见https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html），以下设置被使用

其他设置

用法

设置

将 joist 添加到已安装应用程序列表中

settings.py:

INSTALLED_APPS = [
    ...
    'rest_framework',
    'rest_framework.authtoken',
    'joist',
]

此外，由于该字段需要额外的REST端点，因此必须将它们添加到 urlpatterns 中

urls.py

urlpatterns = [
    ...
    path('api/joist/', include('joist.urls')),
]

模型定义

而不是

photo = models.FileField()

使用

from joist.models import S3FileField

photo = S3FileField()

结果是，一旦用户在文件选择器中选择文件，它将自动在客户端上传到S3。

信号

当Joist的REST API被调用时，Joist会发出两个信号

joist_upload_prepare(name: str, object_key: str)
joist_upload_finalize(name: str, object_key: str, status: string)

开发环境

需求

• Terraform
• AWS CLI
• Python 3.7
• node

初始化AWS

登录AWS控制台并创建API访问密钥

aws configure

运行Terraform

cd terraform
terraform init
terraform workspace new <NAME>
terraform apply

创建环境文件

cd terraform
terraform output > ../example/.env

注意

• 编辑 .env 文件并删除 = 字符周围的空格

初始化Django和Python仓库

pipenv --python=3
pipenv install -r requirements.txt example/requirements.txt
pip install -e .

cd example
./manage.py migrate
./manage.py createsuperuser

初始化仓库预提交

pipenv shell
pip install pre-commit
pre-commit install

初始化小部件客户端

cd client
npm install
npm run dev

初始化测试Vue客户端

cd example-client
npm install

待办事项

cd example
./manager.py runserver

--> 在 https://:8000 和 https://:8000/admin 运行

示例blob表单

• https://:8000/
• https://:8000/new/
• http://127.0.0.1:8000/admin/blobs/blob

cd example-client
npm run serve

--> 在 https://:8080 运行

发布

pipenv shell
pip install bumpversion
bumpversion minor

待办事项：npm发布