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

PR for v.1.0.1

Author: hcpchris

CHANGES.rst

@@ -1,3 +1,12 @@
+Release 1.0.1
+=========================================
+
+* Added documentation of "hard" dependencies to the README.
+* Fixed broken links in documentation to ``options.plot_options.heatmap.HeatmapOptions`` 
+  and ``options.plot_options.heatmap.TilemapOptions``.
+
+---------------
+
 Release 1.0.0
 =========================================
 

README.rst

@@ -78,6 +78,23 @@ To install **Highcharts Maps for Python**, just execute:
 
     $ pip install highcharts-maps
 
+Before you install, please be aware of the following "hard" dependencies:
+
+  * Python 3.10 or higher
+  * Highcharts Maps (JS) v.10.2 or higher (not technically a Python dependency, but 
+    it won't work with earlier versions of Highcharts)
+  * `Highcharts Core for Python <https://core-docs.highchartspython.com/en/latest/>`__ v.1.0 or higher
+  * `esprima-python <https://github.com/Kronuz/esprima-python>`__ v.4.0 or higher
+  * `requests <https://requests.readthedocs.io/en/latest/>`__ v.2.28 or higher
+  * `validator-collection <https://validator-collection.readthedocs.io/en/latest/>`__
+    v.1.5 or higher
+  * `topojson <https://mattijn.github.io/topojson/>`__ v.1.5 or higher
+  * `geojson <https://github.com/jazzband/geojson/>`__ v.3.0 or higher
+
+You can find more information about soft and development dependencies in the
+`complete documentation <https://maps-docs.highchartspython.com/en/latest/#dependencies>`__.
+
+
 -------------
 
 *********************************

docs/api.rst

@@ -348,9 +348,9 @@ Core Components
       :class:`SolidGaugeOptions <highcharts_maps.options.plot_options.gauge.SolidGaugeOptions>`
   * - :mod:`.options.plot_options.generic <highcharts_maps.options.plot_options.generic>`
     - :class:`GenericTypeOptions <highcharts_maps.options.plot_options.generic.GenericTypeOptions>`
-  * - :mod:`.options.plot_options.Heatmap <highcharts_maps.options.plot_options.Heatmap>`
-    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.Heatmap.HeatmapOptions>`
-      :class:`TilemapOptions <highcharts_maps.options.plot_options.Tilemap.TilemapOptions>`
+  * - :mod:`.options.plot_options.heatmap <highcharts_maps.options.plot_options.heatmap>`
+    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.heatmap.HeatmapOptions>`
+      :class:`TilemapOptions <highcharts_maps.options.plot_options.heatmap.TilemapOptions>`
   * - :mod:`.options.plot_options.histogram <highcharts_maps.options.plot_options.histogram>`
     - :class:`HistogramOptions <highcharts_maps.options.plot_options.histogram.HistogramOptions>`
   * - :mod:`.options.plot_options.item <highcharts_maps.options.plot_options.item>`

docs/api/options/index.rst

@@ -300,9 +300,9 @@ Sub-components
       :class:`SolidGaugeOptions <highcharts_maps.options.plot_options.gauge.SolidGaugeOptions>`
   * - :mod:`.options.plot_options.generic <highcharts_maps.options.plot_options.generic>`
     - :class:`GenericTypeOptions <highcharts_maps.options.plot_options.generic.GenericTypeOptions>`
-  * - :mod:`.options.plot_options.Heatmap <highcharts_maps.options.plot_options.Heatmap>`
-    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.Heatmap.HeatmapOptions>`
-      :class:`TilemapOptions <highcharts_maps.options.plot_options.Tilemap.TilemapOptions>`
+  * - :mod:`.options.plot_options.heatmap <highcharts_maps.options.plot_options.heatmap>`
+    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.heatmap.HeatmapOptions>`
+      :class:`TilemapOptions <highcharts_maps.options.plot_options.heatmap.TilemapOptions>`
   * - :mod:`.options.plot_options.histogram <highcharts_maps.options.plot_options.histogram>`
     - :class:`HistogramOptions <highcharts_maps.options.plot_options.histogram.HistogramOptions>`
   * - :mod:`.options.plot_options.item <highcharts_maps.options.plot_options.item>`

docs/api/options/plot_options/index.rst

@@ -146,9 +146,9 @@ Sub-components
       :class:`SolidGaugeOptions <highcharts_maps.options.plot_options.gauge.SolidGaugeOptions>`
   * - :mod:`.options.plot_options.generic <highcharts_maps.options.plot_options.generic>`
     - :class:`GenericTypeOptions <highcharts_maps.options.plot_options.generic.GenericTypeOptions>`
-  * - :mod:`.options.plot_options.Heatmap <highcharts_maps.options.plot_options.Heatmap>`
-    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.Heatmap.HeatmapOptions>`
-      :class:`TilemapOptions <highcharts_maps.options.plot_options.Tilemap.TilemapOptions>`
+  * - :mod:`.options.plot_options.heatmap <highcharts_maps.options.plot_options.heatmap>`
+    - :class:`HeatmapOptions <highcharts_maps.options.plot_options.heatmap.HeatmapOptions>`
+      :class:`TilemapOptions <highcharts_maps.options.plot_options.heatmap.TilemapOptions>`
   * - :mod:`.options.plot_options.histogram <highcharts_maps.options.plot_options.histogram>`
     - :class:`HistogramOptions <highcharts_maps.options.plot_options.histogram.HistogramOptions>`
   * - :mod:`.options.plot_options.item <highcharts_maps.options.plot_options.item>`

highcharts_maps/__version__.py

@@ -1 +1 @@
-__version__ = '1.0.0'
+__version__ = '1.0.1'