安装

安装pip包

pip install django-simplefeedback

如果尚未安装，请安装django-rest-framework

将simple_feedback和rest_framework添加到INSTALLED_APPS

将'simple_feedback.urls'包含到urlpatterns

from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("api/", include("simple_feedback.urls")),
]

迁移数据库以创建simple-feedback模型

python manage.py migrate

设置

SIMPLE_FEEDBACK_NOTIFICATIONS_ENABLED

默认：False

需要在设置中明确启用，才能发送电子邮件。

SIMPLE_FEEDBACK_SEND_TO - 电子邮件字符串或电子邮件字符串列表

有效示例

SIMPLE_FEEDBACK_SEND_TO =
SIMPLE_FEEDBACK_SEND_TO = 'sendto@address.org'
SIMPLE_FEEDBACK_SEND_TO = ['sendto1@address.org', 'sendto2@address.org']

当SIMPLE_FEEDBACK_SEND_TO为空或未定义时，电子邮件接收者将是系统中的所有超级用户。

SIMPLE_FEEDBACK_SEND_MAIL_FUNC_OVERRIDE - 需要实现两个kwargs message和recipients的发送电子邮件函数

有效示例

settings.py:
SIMPLE_FEEDBACK_SEND_MAIL_FUNC_OVERRIDE = send_email_function

def send_email_function(message, recipients):
    send_email()

开发

克隆仓库

git clone git@github.com:pulilab/django-simple-feedback.git

测试应用程序

测试独立应用程序

$ export DATABASE_URL='your_db' # 可以跳过此步骤，默认为'localhost'（使用postgres.app以简化操作）

$ pip install -r requirements.txt

$ python runtests.py

以开发模式运行应用程序

创建一个新的Django项目，并以开发模式安装包

django-admin startproject simple_feedback_demo
cd simple_feedback_demo
pip install -e ~LOCAL_PATH_TO_DJANGO_SIMPLEFEEDBACK

在settings.py中将simple_feedback和rest_framework添加到INSTALLED_APPS

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_framework',
    'simple_feedback'
]

配置演示应用程序URL

from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("api/", include("simple_feedback.urls")),
]

不支持SQLite

在settings.py中将数据库配置更改为使用postgres

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'postgres',
        'USER': 'postgres',
        'HOST': os.environ.get("DATABASE_URL", 'localhost'),
        'PORT': 5432,
    }
}

迁移数据库，创建超级用户并运行您的演示应用程序

python manage.py migrate
python manage.py createsuperuser
python manage.py runserver

在浏览器中打开 http://localhost:8000/admin