└── profile └── README.rst /profile/README.rst: -------------------------------------------------------------------------------- 1 | ################################################### 2 | The Highcharts for Python Toolkit 3 | ################################################### 4 | 5 | **High-end data visualization for the Python ecosystem** 6 | 7 | The **Highcharts for Python Toolkit** is a set of Python libraries that provide a Python wrapper 8 | for the `Highcharts `__ suite of JavaScript data 9 | visualization libraries, with full integration across the Python ecosystem. 10 | 11 | The full toolkit includes support for: 12 | 13 | .. list-table:: 14 | :widths: 30 30 30 15 | :header-rows: 1 16 | 17 | * - Python Library 18 | - JavaScript Library 19 | - Description 20 | * - `Highcharts Core for Python `__ 21 | - `Highcharts Core `__ 22 | - the core Highcharts data visualization library 23 | * - `Highcharts Stock for Python `__ 24 | - `Highcharts Stock `__ 25 | - the time series visualization extension to Highcharts 26 | * - `Highcharts Maps for Python `__ 27 | - `Highcharts Maps `__ 28 | - the map visualization extension to Highcharts 29 | * - `Highcharts Gantt for Python `__ 30 | - `Highcharts Gantt `__ 31 | - the Gantt charting extension to Highcharts 32 | * - all Highcharts for Python libraries 33 | - the **Highcharts Export Server** 34 | - enabling the programmatic creation of static (downloadable) data visualizations 35 | 36 | The toolkit features native integrations with: 37 | 38 | * **Jupyter Labs/Notebook**. You can now produce high-end and interactive plots and 39 | renders using the full suite of Highcharts visualization capabilities. 40 | * **Pandas**. Automatically produce data visualizations from your Pandas dataframes 41 | * **PySpark**. Automatically produce data visualizations from data in a PySpark 42 | dataframe. 43 | * ...and more library-specific integrations, including GeoPandas, PyShp, Topjson, Geojson, Asana, and more 44 | 45 | **COMPLETE DOCUMENTATION:** http://core-docs.highchartspython.com/en/latest/index.html 46 | 47 | -------------------- 48 | 49 | *************** 50 | Installation 51 | *************** 52 | 53 | Highcharts Core for Python 54 | ============================= 55 | 56 | To install **Highcharts Core for Python**, just execute: 57 | 58 | .. code:: bash 59 | 60 | $ pip install highcharts-core 61 | 62 | Highcharts Stock for Python 63 | ================================= 64 | 65 | To install **Highcharts Stock for Python**, just execute: 66 | 67 | .. code:: bash 68 | 69 | $ pip install highcharts-stock 70 | 71 | Highcharts Maps for Python 72 | ================================= 73 | 74 | To install **Highcharts Maps for Python**, just execute: 75 | 76 | .. code:: bash 77 | 78 | $ pip install highcharts-maps 79 | 80 | Highcharts Gantt for Python 81 | ================================= 82 | 83 | To install **Highcharts Gantt for Python**, just execute: 84 | 85 | .. code:: bash 86 | 87 | $ pip install highcharts-gantt 88 | 89 | ------------- 90 | 91 | ************************************ 92 | Why Highcharts for Python? 93 | ************************************ 94 | 95 | `Highcharts `__ is the world's most popular, most powerful, 96 | category-defining JavaScript data visualization library. If you are building a web or 97 | mobile app/dashboard that will be visualizing data in some fashion, you should 98 | absolutely take a look at the Highcharts suite of solutions. Take a peak at some 99 | fantastic `demo visualizations `__. 100 | 101 | As a suite of JavaScript libraries, `Highcharts `__ is 102 | written in JavaScript, and is used to configure and render data visualizations in a 103 | web browser (or other JavaScript-executing) environment. As a set of JavaScript 104 | libraries, its audience is JavaScript developers. But what about the broader ecosystem of 105 | Python developers and data scientists? 106 | 107 | Given Python's increasing adoption as the technology of choice for data science and for 108 | the backends of leading enterprise-grade applications, Python is often the backend that 109 | delivers data and content to the front-end...which then renders it using JavaScript and 110 | HTML. 111 | 112 | There are numerous Python frameworks (Django, Flask, Tornado, etc.) with specific 113 | capabilities to simplify integration with Javascript frontend frameworks (React, Angular, 114 | VueJS, etc.). But facilitating that with Highcharts has historically been very difficult. 115 | Part of this difficulty is because the Highcharts JavaScript suite - while supporting JSON as a 116 | serialization/deserialization format - leverages JavaScript object literals to expose the 117 | full power and interactivity of its data visualizations. And while it's easy to serialize 118 | JSON from Python, serializing and deserializing to/from JavaScript object literal notation 119 | is much more complicated. 120 | 121 | This means that Python developers looking to integrate with Highcharts typically had to 122 | either invest a lot of effort, or were only able to leverage a small portion of Highcharts' 123 | rich functionality. 124 | 125 | So we wrote the **Highcharts for Python** toolkit to bridge that gap. 126 | 127 | **Highcharts for Python** provides Python object representation for *all* of the 128 | JavaScript objects defined in the 129 | `Highcharts (JavaScript) API `__. It provides automatic 130 | data validation, and exposes simple and standardized methods for serializing those Python 131 | objects back-and-forth to JavaScript object literal notation. 132 | 133 | Key Highcharts for Python Features 134 | ====================================== 135 | 136 | * **Clean and consistent API**. No reliance on "hacky" code, ``dict`` 137 | and JSON serialization, or impossible to maintain / copy-pasted "spaghetti code". 138 | * **Comprehensive Highcharts Support**. Every single Highcharts chart type and every 139 | single configuration option is supported in the **Highcharts for Python** toolkit. 140 | This includes the over 70 data visualization types supported by 141 | `Highcharts Core `__ and the 50+ 142 | technical indicator visualizations available in 143 | `Highcharts Stock `__, with full support for 144 | the rich JavaScript formatter (JS callback function) capabilities that are often needed 145 | to get the most out of Highcharts' visualization and interaction capabilities. 146 | 147 | **See Also** 148 | 149 | * `Supported Visualizations `__ 150 | 151 | * **Simple JavaScript Code Generation**. With one method call, produce production-ready 152 | JavaScript code to render your interactive visualizations using Highcharts' rich 153 | capabilities. 154 | * **Easy and Robust Chart Download**. With one method call, produce high-end static 155 | visualizations that can be downloaded or shared as files with your audience. Produce 156 | static charts using the Highsoft-provided **Highcharts Export Server**, or using your 157 | own private export server as needed. 158 | * **Integration with Pandas and PySpark**. With two lines of code, produce a high-end 159 | interactive visualization of your Pandas or PySpark dataframe. 160 | * **Consistent code style**. For Python developers, switching between Pythonic code 161 | conventions and JavaScript code conventions can be...annoying. So 162 | **Highcharts for Python** applies Pythonic syntax with automatic conversion between 163 | Pythonic ``snake_case`` notation and JavaScript ``camelCase`` styles. 164 | 165 | **Highcharts for Python** vs Alternatives 166 | ============================================== 167 | 168 | For a discussion of **Highcharts for Python** in comparison to alternatives, please see 169 | the **COMPLETE DOCUMENTATION:** http://core-docs.highchartspython.com/en/latest/index.html 170 | 171 | ---------------- 172 | 173 | ************************************** 174 | Highcharts for Python Components 175 | ************************************** 176 | 177 | Use the following links to learn more about each of the tools in the **Highcharts for Python** Toolkit: 178 | 179 | * `Highcharts Core for Python `__ 180 | * `Highcharts Stock for Python `__ 181 | * `Highcharts Maps for Python `__ 182 | * `Highcharts Gantt for Python `__ 183 | 184 | --------------------------- 185 | 186 | *************************** 187 | Getting Help / Support 188 | *************************** 189 | 190 | The **Highcharts for Python Toolkit** comes with all of the great support that you are used to from working with the 191 | Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following channels 192 | to get help using the toolkit. In particular, you can: 193 | 194 | * Use the `Highcharts Forums `__ 195 | * Use `Stack Overflow `__ with the 196 | ``highcharts-for-python`` tag 197 | * `Report bugs or request features `__ in one of 198 | our Github repositories 199 | * `File a support ticket `__ with us, or 200 | * `Schedule a live chat or video call `__ with us 201 | 202 | **FOR MORE INFORMATION:** https://www.highchartspython.com/get-help 203 | --------------------------------------------------------------------------------