Merge pull request #158 from highcharts-for-python/rc-v.1.6

Release Candidate: v.1.6.0

CHANGES.rst

@@ -1,4 +1,30 @@
 
+Release 1.6.0
+=========================================
+
+* **ENHANCEMENT:** Align the API to **Highcharts (JS) v.11.3** (#146). In particular, this includes:
+
+  * Added ``ChartOptions.axis_layout_runs`` property.
+  * Added ``ColorAxis.height`` property.
+  * Added ``ColorAxis.width`` property.
+  * Added ``Data.column_types`` property.
+  * Added ``Exporting.fetch_options`` property.
+  * Implemented support for verbose axis date-time unit labelling configuration (see: ``DateTimeLabelFormats``).
+
+
+* **BUGFIX:** Added support for ``nodeFormat`` and ``nodeFormatter`` to tooltip properties for
+  diagram series (Organization, Dependency Wheel, and Sankey). (#148)
+* **ENHANCEMENT:** Added ability to remove or override the JavaScript event listener when 
+  serializing a chart to a JavaScript literal (#131 - courtesy of 
+  `@ByronCook <https://github.com/ByronCook>`__ ).
+* **ENHANCEMENT:** Added support for the ``HCP_ALLOW_SPECIAL_IPS`` environment variable
+  which allows localhost (or other special URLs) to pass URL validation. (#147)
+* **DOCUMENTATION:** Fixed typos in **Getting Started** tutorial. (#149)
+* **DOCUMENTATION:** Fixed typos in documentation (courtesy of `@karlacio <https://github.com/karlacio>`
+  and `@maxduganknight <https://github.com/maxduganknight>`).
+
+--------------------
+
 Release 1.5.1
 =========================================
 

LICENSE

@@ -18,6 +18,8 @@ Without prejudice to the limited right to download and test the Wrapper for eval
 
 A Wrapper License (as defined below) or renewal thereof can only be purchased by a Licensee either already holding a License to the Software, or at the same time as purchasing such a License, as an add-on product to such License, and only by a Licensee holding an active and valid enrolment in the Highcharts Advantage plan. The purchase of, and right to use the Licensed Software shall remain governed by the terms and conditions of the License issued by Highsoft to Licensee, whether this is Highsoft Standard License Agreement, Highsoft Terms and Conditions for Subscription to Annual License to Highsoft Software, or another licensing agreement as agreed between Highsoft and Licensee, as applicable (such terms and conditions between Highsoft and Licensee hereinafter collectively referred to as the “Main Agreement”). 
 
+A Wrapper License (as defined below) can additionally be obtained by holding an active and valid Educational or Personal License to the Software. The right to use the Licensed Software shall remain governed by the terms and conditions of the Authorized User issued by Highsoft to Authorized User, as defined in the Educational and Personal License 1.0, (such terms and conditions between Highsoft and Authorized User hereinafter collectively referred to as the "Main Agreement").
+
 These Wrapper T&Cs constitute an addendum to the Main Agreement and an integral part thereof and apply to the use of the Wrapper only. 
 
 In the case of any discrepancy between the Main Agreement and these Wrapper T&Cs related to the licensing of the Wrapper, these Wrapper T&Cs shall prevail. 
@@ -86,13 +88,16 @@ Licensee shall not modify, delete or obscure any notices of proprietary rights o
 6. Wrapper Support
 ***********************************************
 
-A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee’s valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP.
+A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee’s valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP. In the event that the Licensee is not enrolled in the Highcharts Advantage Plan, for example if the Main Agreement grants the Licensee a Personal or Educational License, then the Licensee shall not be entitled to the support services outlined herein.
 
 All support inquiries related to the Wrapper shall be sent to support@highchartspython.com or filed at https://www.highchartspython.com.
 
-Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP: 
+Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP:
 
   i. All new releases or updates of the Wrapper released during the applicable Advantage Period; 
+
+Under a valid and effective Wrapper License, contingent upon the Licensee’s valid enrollment in the Highcharts Advantage Plan and payment of applicable fees, Licensee shall be entitled to receive from HCP: 
+
   ii. Up to ten (10) hours of the personalized technical support for the Wrapper and/or the Licensed Software 
       (combined) per Developer per Support Year based on the number of Developers stated in the License Statement for 
       the License. Licensee may freely distribute its included total of ten (10) hours of personalized technical 

README.rst

@@ -15,7 +15,7 @@ visualization library, with full integration into the robust Python ecosystem, i
     dataframe.
   * ...and even more use-case specific integrations across the broader toolkit.
 
-The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.2.0.
+The library supports Highcharts (JS) v.10.2 and higher, including Highcharts (JS) v.11.3.0.
 
 **COMPLETE DOCUMENTATION:** https://core-docs.highchartspython.com/en/latest/index.html
 

docs/_contributors.rst

@@ -1,3 +1,6 @@
 * Chris Modzelewski (`@hcpchris <https://github.com/hcpchris>`__ / `@insightindustry <https://github.com/insightindustry>`__)
 * Erin Modzelewski (`@EBModz <https://github.com/EBModz>`__)
-* Jitendra Mishra (`@jmishra01 <https://github.com/jmishra01>`__)
+* Jitendra Mishra (`@jmishra01 <https://github.com/jmishra01>`__)
+* Byron Cook (`@ByronCook <https://github.com/ByronCook>`__)
+* karlacio (`@karlacio <https://github.com/karlacio>`__)
+* Max Dugan Knight (`@maxduganknight <https://github.com/maxduganknight>`__)

docs/errors.rst

@@ -96,6 +96,18 @@ HighchartsNotSupportedError (from :exc:`ValueError <python:ValueError>` and :exc
     .. inheritance-diagram:: HighchartsNotSupportedError
       :parts: -1
 
+--------------------
+
+HighchartsInstanceNeededError (from :exc:`HighchartsNotSupportedError <HighchartsNotSupportedError>` and :exc:`TypeError <python:TypeError>`)
+====================================================================================================================================
+
+.. autoexception:: HighchartsInstanceNeededError
+
+  .. collapse:: Class Inheritance
+
+    .. inheritance-diagram:: HighchartsInstanceNeededError
+      :parts: -1
+
 --------------
 
 HighchartsJavaScriptError (from :class:`ValueError <python:ValueError>`)

docs/index.rst

@@ -37,7 +37,7 @@ Highcharts Core for Python
 
 .. sidebar:: Version Compatibility
 
-  **Latest Highcharts (JS) version supported:** v.11.2.0
+  **Latest Highcharts (JS) version supported:** v.11.3.0
 
   **Highcharts Core for Python** is designed to be compatible with:
 
@@ -289,7 +289,7 @@ Hello World, and Basic Usage
     # EXAMPLE 1.
     # Using dicts
     my_chart.title = {
-        'align': 'center'
+        'align': 'center',
         'floating': True,
         'text': 'The Title for My Chart',
         'use_html': False,

docs/license.rst

@@ -10,6 +10,7 @@ Terms and Conditions for the Highcharts for Python Toolkit License
   creators of the Highcharts JavaScript library.
 
   **TO PURCHASE A LICENSE:** `https://shop.highcharts.com/ <https://shop.highcharts.com/>`__
+  **TO APPLY FOR A PERSONAL / EDUCATIONAL LICENSE:** `https://shop.highcharts.com/contact/educational <https://shop.highcharts.com/contact/educational>`__
 
 ***********************************************
 1. Acceptance of the Terms and Conditions
@@ -27,6 +28,8 @@ Without prejudice to the limited right to download and test the Wrapper for eval
 
 A Wrapper License (as defined below) or renewal thereof can only be purchased by a Licensee either already holding a License to the Software, or at the same time as purchasing such a License, as an add-on product to such License, and only by a Licensee holding an active and valid enrolment in the Highcharts Advantage plan. The purchase of, and right to use the Licensed Software shall remain governed by the terms and conditions of the License issued by Highsoft to Licensee, whether this is Highsoft Standard License Agreement, Highsoft Terms and Conditions for Subscription to Annual License to Highsoft Software, or another licensing agreement as agreed between Highsoft and Licensee, as applicable (such terms and conditions between Highsoft and Licensee hereinafter collectively referred to as the “Main Agreement”). 
 
+A Wrapper License (as defined below) can additionally be obtained by holding an active and valid Educational or Personal License to the Software. The right to use the Licensed Software shall remain governed by the terms and conditions of the Authorized User issued by Highsoft to Authorized User, as defined in the Educational and Personal License 1.0, (such terms and conditions between Highsoft and Authorized User hereinafter collectively referred to as the "Main Agreement").
+
 These Wrapper T&Cs constitute an addendum to the Main Agreement and an integral part thereof and apply to the use of the Wrapper only. 
 
 In the case of any discrepancy between the Main Agreement and these Wrapper T&Cs related to the licensing of the Wrapper, these Wrapper T&Cs shall prevail. 
@@ -95,13 +98,16 @@ Licensee shall not modify, delete or obscure any notices of proprietary rights o
 6. Wrapper Support
 ***********************************************
 
-A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee’s valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP.
+A Wrapper License entitles Licensee to the support services and access to new Releases of the Wrapper as set out herein. While support for the Wrapper is contingent upon Licensee's valid enrollment in the Highcharts Advantage plan and the annual number of hours of support available for support of the Licensed Software for each successive twelve month term during the period that Licensee is enrolled in Highcharts Advantage (each, a “Support Year”) are inclusive of the number of hours of support offered during such Support Year for the Wrapper, support of the Wrapper is not covered under Licensee’s enrollment in Highcharts Advantage, but is offered by Highsoft for a separate fee and provided separately, directly and independently by HCP. In the event that the Licensee is not enrolled in the Highcharts Advantage Plan, for example if the Main Agreement grants the Licensee a Personal or Educational License, then the Licensee shall not be entitled to the support services outlined herein.
 
 All support inquiries related to the Wrapper shall be sent to support@highchartspython.com or filed at https://www.highchartspython.com.
 
-Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP: 
+Under a valid and effective Wrapper License, Licensee shall be entitled to receive from HCP:
 
   i. All new releases or updates of the Wrapper released during the applicable Advantage Period; 
+
+Under a valid and effective Wrapper License, contingent upon the Licensee’s valid enrollment in the Highcharts Advantage Plan and payment of applicable fees, Licensee shall be entitled to receive from HCP: 
+
   ii. Up to ten (10) hours of the personalized technical support for the Wrapper and/or the Licensed Software 
       (combined) per Developer per Support Year based on the number of Developers stated in the License Statement for 
       the License. Licensee may freely distribute its included total of ten (10) hours of personalized technical 

docs/tutorials/_assembling_a_chart.rst

@@ -18,7 +18,7 @@ from a :class:`pandas.DataFrame <pandas:pandas.DataFrame>`,
 
     # From a Numpy ndarray
 
-    my_chart = Chart.from_array(data = as_ndarray, series_type = 'line')
+    my_chart = Chart.from_array(as_ndarray, series_type = 'line')
 
     # From a Python dict
 

docs/tutorials/getting_started.rst

@@ -92,7 +92,7 @@ or Python :class:`dict <python:dict>`:
     df = pandas.DataFrame(my_iterable, columns=['x', 'y'])
 
     # As a Numpy ndarray
-    as_ndarray = numpy.as_ndarray(my_iterable)
+    as_ndarray = numpy.asarray(my_iterable)
 
     # As a Python dict
     as_dict = {'x': x[0], 'y': x[1] for x in my_iterable}

highcharts_core/__version__.py

@@ -1 +1 @@
-__version__ = '1.5.1'
+__version__ = '1.6.0'

highcharts_core/ai.py

@@ -103,6 +103,8 @@
     'gpt-3.5-turbo-16k': ('OpenAI', OPENAI_MESSAGES),
     'gpt-4': ('OpenAI', OPENAI_MESSAGES),
     'gpt-4-32k': ('OpenAI', OPENAI_MESSAGES),
+    'gpt-4-1106-preview': ('OpenAI', OPENAI_MESSAGES),
+    'gpt-4-vision-preview': ('OpenAI', OPENAI_MESSAGES),
     'claude-instant-1': ('Anthropic', ANTHROPIC_PROMPT),
     'claude-2': ('Anthropic', ANTHROPIC_PROMPT),
 }
@@ -157,6 +159,8 @@ def convert_to_js(callable,
         * ``'gpt-3.5-turbo-16k'``
         * ``'gpt-4'``
         * ``'gpt-4-32k'``
+        * ``'gpt-4-1106-preview'``
+        * ``'gpt-4-vision-preview'``
         * ``'claude-instant-1'``
         * ``'claude-2'``