Merge pull request #117 from highcharts-for-python/develop

PR for v.1.4.0

Author: hcpchris

.gitignore

@@ -109,7 +109,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
-.py310/
+.py31*/
 
 # Spyder project settings
 .spyderproject

.travis.yml

@@ -1,10 +1,6 @@
 language: python
 job:
  include:
- #- python: "3.8"
- # env: TOXENV=py38
- #- python: "3.9"
- # env: TOXENV=py39
  - python: "3.10"
  dist: focal
  env: TOXENV=py310

CHANGES.rst

@@ -1,4 +1,29 @@
 
+Release 1.4.0
+=========================================
+
+* **MAJOR** performance gains in the ``.to_js_literal()`` method. Implementation seems to
+ improve performance by 50 - 90%. (#51)
+* *SIGNIFICANT* performance gains in the ``.to_json()`` method. Implementation seems to 
+ improve performance by 30 - 90%.
+* **ENHANCEMENT:** Significantly simplified use of the ``.from_pandas()`` method to support:
+
+ * creation of multiple series from one DataFrame in one method call
+ * creation of series without needing to specify a full property map
+ * support for creating series by DataFrame row, rather than just by DataFrame column
+
+* **ENHANCEMENT:** Added the ``.from_pandas_in_rows()`` method to support creation of
+ charts and series from simple two-dimensional DataFrames laid out in rows.
+* **ENHANCEMENT:** Added one-shot chart creation and rendering from Series objects (#89).
+* **ENHANCEMENT:** Added one-shot chart creation using ``series`` and ``data``/``series_type`` keywords. (#90).
+* **ENHANCEMENT:** Added ``.convert_to()`` convenience method to Series objects (#107).
+* **ENHANCEMENT:** Added ``CallbackFunction.from_python()`` method which converts a Python function
+ to its JavaScript equivalent using generative AI, with support for both OpenAI and Anthropic (#109).
+* **BUGFIX:** Fixed instability issues in Jupyter Notebooks, both when operating as a Notebook (outside of 
+ Jupyter Lab) and when saved to a static HTML file (#66).
+
+--------------------
+
 Release 1.3.7
 =========================================
 

README.rst

@@ -212,49 +212,53 @@ Hello World, and Basic Usage
 
  .. code-block:: python
 
+ # from a primitive array, using keyword arguments
+ my_chart = Chart(data = [[1, 23], [2, 34], [3, 45]], 
+ series_type = 'line')
+
+ # from a primitive array, using the .from_array() method
+ my_chart = Chart.from_array([[1, 23], [2, 34], [3, 45]], 
+ series_type = 'line')
+
+ # from a Numpy ndarray, using keyword arguments
+ my_chart = Chart(data = numpy_array, series_type = 'line')
+
+ # from a Numpy ndarray, using the .from_array() method
+ my_chart = Chart.from_array(data = numpy_array, series_type = 'line')
+
  # from a JavaScript file
- my_chart = highcharts.Chart.from_js_literal('my_js_literal.js')
+ my_chart = Chart.from_js_literal('my_js_literal.js')
 
  # from a JSON file
- my_chart = highcharts.Chart.from_json('my_json.json')
+ my_chart = Chart.from_json('my_json.json')
 
  # from a Python dict
- my_chart = highcharts.Chart.from_dict(my_dict_obj)
+ my_chart = Chart.from_dict(my_dict_obj)
 
  # from a Pandas dataframe
- my_chart = highcharts.Chart.from_pandas(df,
- property_map = {
- 'x': 'transactionDate',
- 'y': 'invoiceAmt',
- 'id': 'id'
- },
- series_type = 'line')
+ my_chart = Chart.from_pandas(df)
 
  # from a PySpark dataframe
- my_chart = highcharts.Chart.from_pyspark(df,
-  property_map = {
-  'x': 'transactionDate',
-  'y': 'invoiceAmt',
-  'id': 'id'
-  },
-  series_type = 'line')
+ my_chart = Chart.from_pyspark(df,
+ property_map = {
+ 'x': 'transactionDate',
+ 'y': 'invoiceAmt',
+ 'id': 'id'
+ },
+ series_type = 'line')
 
  # from a CSV
- my_chart = highcharts.Chart.from_csv('/some_file_location/filename.csv'
- column_property_map = {
- 'x': 0,
- 'y': 4,
- 'id': 14
- },
- series_type = 'line')
+ my_chart = Chart.from_csv('/some_file_location/filename.csv')
 
  # from a HighchartsOptions configuration object
- my_chart = highcharts.Chart.from_options(my_options)
-
- # from a Series configuration
- my_chart = highcharts.Chart.from_series(my_series)
+ my_chart = Chart.from_options(my_options)
 
+ # from a Series configuration, using keyword arguments
+ my_chart = Chart(series = my_series)
 
+ # from a Series configuration, using .from_series()
+ my_chart = Chart.from_series(my_series)
+ 
 3. Configure Global Settings (optional)
 =============================================
 
@@ -284,6 +288,7 @@ Hello World, and Basic Usage
  from highcharts_core.options.title import Title
  from highcharts_core.options.credits import Credits
 
+ # EXAMPLE 1.
  # Using dicts
  my_chart.title = {
  'align': 'center'
@@ -294,7 +299,7 @@ Hello World, and Basic Usage
 
  my_chart.credits = {
  'enabled': True,
- 'href': 'https://www.highcharts.com/',
+ 'href': 'https://www.highchartspython.com/',
  'position': {
  'align': 'center',
  'vertical_align': 'bottom',
@@ -309,17 +314,21 @@ Hello World, and Basic Usage
  'text': 'Chris Modzelewski'
  }
 
+ # EXAMPLE 2.
  # Using direct objects
  from highcharts_core.options.title import Title
  from highcharts_core.options.credits import Credits
 
- my_title = Title(text = 'The Title for My Chart', floating = True, align = 'center')
+ my_title = Title(text = 'The Title for My Chart',
+ floating = True, 
+ align = 'center')
  my_chart.options.title = my_title
 
- my_credits = Credits(text = 'Chris Modzelewski', enabled = True, href = 'https://www.highcharts.com')
+ my_credits = Credits(text = 'Chris Modzelewski', 
+ enabled = True, 
+ href = 'https://www.highchartspython.com')
  my_chart.options.credits = my_credits
 
-
 5. Generate the JavaScript Code for Your Chart
 =================================================
 
@@ -328,9 +337,11 @@ that will render the chart wherever it is you want it to go:
 
  .. code-block:: python
 
+ # EXAMPLE 1.
  # as a string
  js_as_str = my_chart.to_js_literal()
 
+ # EXAMPLE 2.
  # to a file (and as a string)
  js_as_str = my_chart.to_js_literal(filename = 'my_target_file.js')
 
@@ -359,6 +370,14 @@ that will render the chart wherever it is you want it to go:
  my_image_bytes = my_chart.download_chart(filename = 'my_target_file.png',
  format = 'png')
 
+
+8. Render Your Chart in a Jupyter Notebook
+===============================================
+
+ .. code-block:: python
+
+ my_chart.display()
+
 --------------
 
 ***********************

docs/_dependencies.rst

@@ -56,11 +56,14 @@
  $ pip install highcharts-core[soft]
 
  * `IPython <https://ipython.org/>`__ v. 8.10 or higher
+ * `Jupyter Notebook <https://jupyter.org/>`__ v.6.4 or higher
  * `orjson <https://github.com/ijl/orjson>`__ v.3.7.7 or higher
+ * `NumPy <https://numpy.org>`__ v.1.19.3 or higher
  * `pandas <https://pandas.pydata.org/>`_ v. 1.3 or higher
  * `pyspark <https://spark.apache.org/docs/latest/api/python/index.html>`_ v.3.3 or
  higher
 
+
  .. tab:: Developer
 
  .. warning::