Merge pull request #23 from kinegratii/dev

release v0.3.6

Author: kinegratii

MANIFEST.in

@@ -1,2 +0,0 @@
-include django_echarts/templates/*.html
-include django_echarts/templates/tags/*.html

README.md

@@ -17,14 +17,33 @@ django-echarts 主要提供了以下的内容：
 
 ## 安装
 
-### Python3 Only
+### pyecharts
 
-django-echarts 只支持 Python3.5 以上 的开发环境。
+请根据你的 pyecharts 版本安装 django-echarts 。
+
+> django-echarts 暂未适配 pyecharts v0.5.x ，敬请期待。
+
+
+| django-echarts | pyecharts | 备注 |
+| ------ | ------ | ------ |
+| 0.3.x | 0.3.x - 0.4.x | |
+
+### Python & Django
+
+django-echarts **只支持** ：
+
+-  Python3.5+
+- Django 1.11 LTS 或 Django 2.0+
+
+### 安装方式
+
+可以使用 pip 在线安装。
 
 ```shell
 pip install django-echarts
 ```
 
+
 或者使用源码构建
 
 ```shell
@@ -33,15 +52,6 @@ cd django-echarts
 python setup.py install
 ```
 
-### 其他
-
-其他安装要求为：
-
-- pyecharts 0.3+
-- Django 1.11 LTS 或 Django 2.0+
-
-
-
 ## 快速使用
 
 1 添加 django_echarts包到项目配置模块的 `INSTALL_APPS`列表。

django_echarts/__init__.py

@@ -2,5 +2,5 @@
 A django app for Echarts integration with pyecharts as chart builder.
 """
 
-__version__ = '0.3.5'
+__version__ = '0.3.6'
 __author__ = 'kinegratii'

django_echarts/datasets/charts.py

@@ -8,10 +8,10 @@ class NamedCharts:
     A data structure class containing multiple named charts.
     """
 
-    def __init__(self, page_title='EChart', **kwargs):
+    def __init__(self, page_title='EChart', **name_chart_pair):
         self.page_title = page_title
         self._charts = OrderedDict()
-        for k, v in kwargs.items():
+        for k, v in name_chart_pair.items():
             self.add_chart(chart=v, name=k)
 
     def add_chart(self, chart, name=None):
@@ -20,7 +20,7 @@ def add_chart(self, chart, name=None):
         return self
 
     def _next_name(self):
-        return 'c{}'.format(len(self._charts))
+        return 'c{}'.format(len(self))
 
     # List-like feature
 
@@ -60,8 +60,8 @@ def js_dependencies(self):
         return merge_js_dependencies(*self)
 
     @classmethod
-    def from_charts(cls, *args):
+    def from_charts(cls, *charts):
         mc = cls()
-        for c in args:
-            mc.add_chart(c)
+        for chart in charts:
+            mc.add_chart(chart)
         return mc

django_echarts/templates/tags/echarts.html

@@ -1,6 +1,12 @@
 更新日志
 =========
 
+v0.3.6 (20180530)
+-----------------
+
+- 优化 `Page` 类实现
+- 发布独立的 `Page` 文档
+
 v0.3.5 (20180504)
 -----------------
 

docs/changelog.rst

@@ -55,9 +55,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '0.3.5'
+version = '0.3.6'
 # The full version, including alpha/beta/rc tags.
-release = '0.3.5'
+release = '0.3.6'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/conf.py

@@ -0,0 +1,81 @@
+数据结构
+=========
+
+**注意**：从 pyecharts v0.5.4 开始， `pyecharts.Page` 类也支持 *图表命名引用*， 因此可以直接使用 `pyecharts.Page` 类。
+
+多图表渲染
+----------
+
+.. versionadded:: 0.3.4
+
+自 v0.3.4 新增 `django_echarts.datasets.charts.NamedCharts` 用于多图表渲染，该类是对于原有的 `pyecharts.custom.page.Page` 进行改善，包括：
+
+- 增加图表对象命名引用
+- 移除了 `list` 的相关方法
+
+基本使用
+++++++++
+
+
+在创建一个 `NamedCharts` 实例 `charts` ，后，使用 `add_chart` 添加一个图表对象，可以使用 `name` 为之起一个引用名称，如果没有指定引用名称，则使用 c0,c1 命名。
+
+::
+
+
+    class MultipleChartsView(EChartsBackendView):
+        echarts_instance_name = 'charts'
+        template_name = 'multiple_charts.html'
+
+        def get_echarts_instance(self, *args, **kwargs):
+            device_data = models.Device.objects.values('device_type').annotate(count=Count('device_type'))
+            device_types, counters = fetch(device_data, 'device_type', 'count')
+            pie = Pie("设备分类", page_title='设备分类', width='100%')
+            pie.add("设备分类", device_types, counters, is_label_show=True)
+
+            battery_lifes = models.Device.objects.values('name', 'battery_life')
+            names, lifes = fetch(battery_lifes, 'name', 'battery_life')
+            bar = Bar('设备电量', page_title='设备电量', width='100%')
+            bar.add("设备电量", names, lifes)
+            charts = NamedCharts().add_chart(pie, name='pie').add_chart(bar)
+            return charts
+
+元素访问
+++++++++
+
+.. versionchanged:: 0.3.5
+   图表访问方式从 *属性访问* 改为 *字典访问* 。
+
+对于 包含若干图表的 `NamedCharts` 实例，可以像字典一样访问该图表对象。
+
+Python 代码的访问方式
+
+::
+
+    # 访问 pie 对象 page_title
+    print(charts['pie'].page_title)
+
+    # 访问 bar 对象 page_title
+    print(charts['c1'].page_title) # 推荐
+    print(charts[1].page_title) # 不再推荐
+
+模板代码的访问方式：
+
+::
+
+    {{ charts.pie.page_title }}
+    {{ charts.c1.page_title }}
+
+注意
+
+::
+
+    无论是 Jinja2 模板还是 Django 模板，均不提倡使用 `charts.1` 形式访问列表中的某一个元素。
+
+NamedCharts VS Page
++++++++++++++++++++
+
+`NamedCharts` 内部使用 `collections.OrderedDict` 保存图表名称和实例，支持字典访问方式，同时扩展原有的 `Page` 的列表特性。
+
+具体差别如下表：
+
+.. image:: /_static/namedcharts-vs-page.png

docs/datastructure.rst

@@ -27,6 +27,7 @@ django-echarts 仅支持 Python3.5+ 的开发环境, Django 版本要求为 2.0+
    tutorial
    topics
    data_builder
+   datastructure
    fetch
    api
    development

docs/index.rst

@@ -142,83 +142,6 @@ django_echarts 提供两种方式的渲染视图，即：
         });
     </script>
 
-多图表渲染
-----------
-
-.. versionadded:: 0.3.4
-
-自 v0.3.4 新增 `django_echarts.datasets.charts.NamedCharts` 用于多图表渲染，该类是对于原有的 `pyecharts.custom.page.Page` 进行改善，包括：
-
-- 增加图表对象命名引用
-- 移除了 `list` 的相关方法
-
-基本使用
-++++++++
-
-
-在创建一个 `NamedCharts` 实例 `charts` ，后，使用 `add_chart` 添加一个图表对象，可以使用 `name` 为之起一个引用名称，如果没有指定引用名称，则使用 c0,c1 命名。
-
-::
-
-
-    class MultipleChartsView(EChartsBackendView):
-        echarts_instance_name = 'charts'
-        template_name = 'multiple_charts.html'
-
-        def get_echarts_instance(self, *args, **kwargs):
-            device_data = models.Device.objects.values('device_type').annotate(count=Count('device_type'))
-            device_types, counters = fetch(device_data, 'device_type', 'count')
-            pie = Pie("设备分类", page_title='设备分类', width='100%')
-            pie.add("设备分类", device_types, counters, is_label_show=True)
-
-            battery_lifes = models.Device.objects.values('name', 'battery_life')
-            names, lifes = fetch(battery_lifes, 'name', 'battery_life')
-            bar = Bar('设备电量', page_title='设备电量', width='100%')
-            bar.add("设备电量", names, lifes)
-            charts = NamedCharts().add_chart(pie, name='pie').add_chart(bar)
-            return charts
-
-元素访问
-++++++++
-
-.. versionchanged:: 0.3.5
-   图表访问方式从 *属性访问* 改为 *字典访问* 。
-
-对于 包含若干图表的 `NamedCharts` 实例，可以像字典一样访问该图表对象。
-
-Python 代码的访问方式
-
-::
-
-    # 访问 pie 对象 page_title
-    print(charts['pie'].page_title)
-
-    # 访问 bar 对象 page_title
-    print(charts['c1'].page_title) # 推荐
-    print(charts[1].page_title) # 不再推荐
-
-模板代码的访问方式：
-
-::
-
-    {{ charts.pie.page_title }}
-    {{ charts.c1.page_title }}
-
-注意
-
-::
-
-    无论是 Jinja2 模板还是 Django 模板，均不提倡使用 `charts.1` 形式访问列表中的某一个元素。
-
-NamedCharts VS Page
-+++++++++++++++++++
-
-`NamedCharts` 内部使用 `collections.OrderedDict` 保存图表名称和实例，支持字典访问方式，同时扩展原有的 `Page` 的列表特性。
-
-具体差别如下表：
-
-.. image:: /_static/namedcharts-vs-page.png
-
 
 模板标签
 ---------