commit 62145815222d57c2a237e1cb96559e351a4758d3 Author: JohnYan <84345999@qq.com> Date: Sun Nov 29 12:40:44 2020 +0800 Initial commit diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9ca91b --- /dev/null +++ b/README.md @@ -0,0 +1,141 @@ + +#### SmartChart是一个基于Echarts的微代码开发平台 +#### Django-smartchart是基于smartchart进行了简化,可轻松应用于django,让你项目页面图形定制非常方便 +

简单, 敏捷, 高效, 通用化, 高度可定制化

+#### 为你完全打通前后端, 图形数据联动, 筛选开发毫无压力 +#### 支持集木式的开发模式 +#### 我们让简单和通用化不再是个矛盾体 +#### [社区版开源免费使用](http://smartchart.cn/blog/article/2020/11/27/54.html "社区版开源免费使用")!! +![](http://smartchart.cn/media/editor/WX20201128-075135@2x_20201128075202927382.png) + +#### 安装使用说明: +```shell script + +pip install django-smartchart + +安装完成后, 你可以直接在命令行输入smartchart,即可启动 +访问url: http://127.0.0.1:8000, 帐号密码都是admin + +你也可以在你的django项目中当作apps使用, 简单配置一下, 你可以参考此demo +1. 在你的setting.py的INSTALL_APPS中加入'smart_chart.echart' +2. MIDDLEWARE 中注释掉XFrameOptionsMiddleware +3. 将你的设定为中国时区, 支持中文基础平台建设! + LANGUAGE_CODE = 'zh-hans' + TIME_ZONE = 'Asia/Shanghai' + USE_I18N = True + USE_L10N = True + USE_TZ = False +4. 在你的url.py中加入引用 +from django.conf.urls import include +from django.views.generic import RedirectView +5. urlpatterns中加入路由 + path('echart/', include('smart_chart.echart.urls')), + path('', RedirectView.as_view(url='echart/index/')), #smartchart报表管理页, 自行更改路由 +6. 初始化DB, 命令行输入: + python manage.py migrate +7. 建立管理员帐号, 如果已有可忽略 + python manage.py createsuperuser +8. 启动服务 + python manage.py runserver +9. 访问http://127.0.0.1:8000/echart/init_db/ 进行数据初始化 + +你就可以愉快的使用smartchart了 + +``` +### 更多使用说明: +font size=5 color=red>SmartChart designed for you + +#### SmartChart是为你而生的一个产品, 你只需要使用通用开发技术就可以使用,无需学习特定的技能, 因为她的通用性, 所以让你的知识不会因为改变而淘汰 +#### 因为她的灵活性, 你可以充分发挥你的智慧让她变得非常的Smart +#### 抛弃繁琐的操作, 加速你的开发效率, 和BI产品相比, 如同Linux与Window的区别 + +她是一个数据集装箱, 让你非常方便的把数据组装起来后, 可使用统一的接口对外服务,支持系统间嵌入,实时,快速定制化开发. 你也可以理解为数据中台, 用可视化提供统一数据服务. 这是一个面向开发人员的平台, 实现数据的最后一公里 + +![](/media/editor/logo8_20200611075317556690.png) + +- 开始使用smart chart, 您不需要任何专业知识, 无需coding, 选择模块组装即可! +- 但如果要使用好smart chart, 建意了解下javascript, H5, Echart这些前端知识, 可以让你的应用更加得心应手,创作更炫的效果 +- 如果你需要更进一步订制你的数据, 你需要了解下SQL的使用,本项目高级应用语言都是通用的技能, 象js, h5,sql 学习成本低 + +#### 入门视屏说明 + + + +#### Smart Chart 基础 +主要分为 数据连接池, 数据集, 图形格式, 页面模板, 主题, 组装盒(Dashboard) +- (数据集+图形格式) => 图形(report) +- (图形report+report+...) + 页面模板 + 主题 => Dashboard + +**一般企业应用** +- 数据连接池 + 数据集 => 统一数据接口 由 IT(数据建模工程师完成) +- 图形格式 + 页面模板 + 组装 => 统一可视化接口 由数据分析师或业务完成 + +**开发流程** + +数据分析师&业务 确定好需求, 进行页面草图设计, 提出数据需求给建模工程师, 完成数据接口后, 数据分析师&业务挑选图形格式(含powerbi, tableau等BI产品), 模板进行组装, 特殊展示需求对相应的code进行修改(js, html) + + +###数据集 +数据集可以理解为一个个的cube, 通过sql生成, 支持定时, 点频, 实时刷新的机制, 我们建意你用专业的工具开发sql 查询, 如navicate,datagrip,hue +数据集的高级用法, 参考如下链接 [数据集图形对应关系](https://www.smartchart.cn/blog/article/2019/7/9/10.html "数据集图形对应关系") +**对于一般用户来说, 无需了解如何生成数据集, 但建意了解以下数据集的常识** +数据集统一向图形传递数据的参数名为dataset, dataset是一个二维表结构, 如下 +```python +dataset = [ +['时间','人口','发展','潜力'], +['2018年', 12 , 10 , 9], +['2017年', 8 , 7 , 3], +...... +] + +``` + +###图形设定 +smartchart内置了非常多的图形, 可以直接拿来使用, 但是要定制自已的样式, 建意稍作修改, 比如加上图形, 更改tips, 标题等等, 具体修改方式, 请参考[smartchart平台样列](https://www.smartchart.cn/echart/editor_min/?chartid=69 "smartchart平台样列") + +如果你想进一步了解, 你可以参考 [自定义图形指南](https://www.smartchart.cn/blog/article/2019/8/21/14.html "自定义图形指南") + +PowerBI/Tableau嵌入的也虚拟成了图形格式, 具体方式见另一文章 + +那接下来我们需要给图形一个舞台, 那就是模板, + + +###模版 +模版就是一个html页面, 理论上来说, 你可以随意发挥, 为了让不太懂html的同学定制自已的模板, 我们提供了可视化开发模板,设计好的code复制过去覆盖这一块代码即可, 如有其它需求可自行修改(前提你得稍微会点h5:tw-1f453: :tw-1f43e:) +每一个div对应一个DIV格式, 可以比喻成给图形包一件衣服,我们会把图形绑定到这个容器中,你可以用它来设定容器的样式,如长宽高,边距,边框等等: +```html +
+``` +更多模板使用说明, 请参考: [模板指南](https://www.smartchart.cn/blog/article/2019/11/24/30.html "模板指南") + +你也可以使用 [可视化设计工具](https://www.smartchart.cn/echart/layout "可视化设计工具") 进行模板的开发 +接下来只需要在dashborad中进行组装就可以了 + + +###Dashboard +选择你需要拼装的数据集,对应的图形,你也可以修改div, 让他更适合当前页面的需求, 选择你喜欢的主题, 会自动应用到页面 + +![](/media/editor/westeros_20190601130951364261.png) + +具体高级用法在后续的使用说明中会进行细化, +与我联系请关注公众号给我留言,获取开发者权限： + +![](/media/editor/qrcode_for_gh_95bb6f18ade8_258_20201004120759761572.jpg) + +#####估计以让说明你有点不知如何下手, 下面你可以STEP by STEP 的去尝试 +- [SmartChart入门](https://www.smartchart.cn/blog/article/2019/12/14/33.html "SmartChart入门") +- [组装Dashboard](https://www.smartchart.cn/blog/article/2019/6/7/7.html "组装Dashboard") +- [你的第一个模板](https://www.smartchart.cn/blog/article/2019/6/8/8.html "你的第一SMART CHART 模板") +- [数据集使用指南](https://www.smartchart.cn/blog/article/2019/7/9/10.html "数据集使用指南") +- [自定义图形指南](https://www.smartchart.cn/blog/article/2019/8/21/14.html "自定义图形指南") +- [模板开发指南](https://www.smartchart.cn/blog/article/2019/11/24/30.html "模板开发指南") +- [dashboard权限管理](https://www.smartchart.cn/blog/article/2019/9/13/17.html "dashboard权限管理") +- [图形简单联动指南](https://www.smartchart.cn/blog/article/2019/10/26/25.html "图形联动指南") +- [筛选器设计指南](https://www.smartchart.cn/blog/article/2019/10/21/24.html "筛选器设计指南") +- [联动钻取设计指南](https://www.smartchart.cn/blog/article/2019/10/27/26.html "钻取设计指南") +- [共享数据集指南](https://www.smartchart.cn/blog/article/2019/10/30/27.html "公用数据集指南") +- [动态播放效果](https://www.smartchart.cn/blog/article/2020/8/21/46.html "动态播放效果") +- [可视化设计工具](https://www.smartchart.cn/blog/article/2019/9/22/18.html "可视化设计工具") +- [图形在线调试](https://www.smartchart.cn/echart/editor/ "图形在线调试") +- [视屏教程一](https://www.ixigua.com/6887009904889070094/ "视屏教程一") +- [视屏教程二](https://www.ixigua.com/6882218819964797447/ "视屏教程二") \ No newline at end of file diff --git a/django_smartchart/__init__.py b/django_smartchart/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/django_smartchart/asgi.py b/django_smartchart/asgi.py new file mode 100644 index 0000000..1d247fc --- /dev/null +++ b/django_smartchart/asgi.py @@ -0,0 +1,16 @@ +""" +ASGI config for django_smartchart project. + +It exposes the ASGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/ +""" + +import os + +from django.core.asgi import get_asgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_smartchart.settings') + +application = get_asgi_application() diff --git a/django_smartchart/settings.py b/django_smartchart/settings.py new file mode 100644 index 0000000..4c6e55d --- /dev/null +++ b/django_smartchart/settings.py @@ -0,0 +1,123 @@ +""" +Django settings for django_smartchart project. + +Generated by 'django-admin startproject' using Django 3.1.3. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/3.1/ref/settings/ +""" + +from pathlib import Path +import os + +# Build paths inside the project like this: BASE_DIR / 'subdir'. +BASE_DIR = Path(__file__).resolve().parent.parent + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/3.1/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = '#$lc1_v_)tof%192ew9fow#o+1#d1qu74d@c11y*sgjqkkl*&b' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'smart_chart.echart' +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + # 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'django_smartchart.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [os.path.join(BASE_DIR, 'templates')] + , + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'django_smartchart.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/3.1/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': BASE_DIR / 'db.sqlite3', + } +} + + +# Password validation +# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/3.1/topics/i18n/ + +LANGUAGE_CODE = 'zh-hans' + +TIME_ZONE = 'Asia/Shanghai' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = False + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/3.1/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/django_smartchart/urls.py b/django_smartchart/urls.py new file mode 100644 index 0000000..651bcb0 --- /dev/null +++ b/django_smartchart/urls.py @@ -0,0 +1,25 @@ +"""django_smartchart URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/3.1/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path +from django.conf.urls import include +from django.views.generic import RedirectView + +urlpatterns = [ + path('admin/', admin.site.urls), + path('echart/', include('smart_chart.echart.urls')), + path('', RedirectView.as_view(url='echart/index/')), +] diff --git a/django_smartchart/wsgi.py b/django_smartchart/wsgi.py new file mode 100644 index 0000000..0dc21a8 --- /dev/null +++ b/django_smartchart/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for django_smartchart project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/3.1/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_smartchart.settings') + +application = get_wsgi_application() diff --git a/manage.py b/manage.py new file mode 100755 index 0000000..92429ad --- /dev/null +++ b/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + """Run administrative tasks.""" + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'django_smartchart.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main()