Skip to content

Commit bd16a92

Browse files
committed
Revised documentation.
1 parent b85326d commit bd16a92

25 files changed

+467
-373
lines changed

CHANGES.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
Release 1.0.0-rc3
2+
=========================================
3+
4+
* Revised the documentation.
5+
6+
---------------
7+
18
Release 1.0.0-rc2
29
=========================================
310

README.rst

Lines changed: 67 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,32 @@
11
###################################################
2-
Highcharts for Python Toolkit
2+
Highcharts Core for Python
33
###################################################
44

55
**High-end data visualization for the Python ecosystem**
66

7-
The **Highcharts for Python Toolkit** is a Python library that provides a Python wrapper
8-
for the fantastic `Highcharts JS <https://www.highcharts.com>`__ suite of JavaScript data
9-
visualization libraries, with full integration into the robust Python ecosystem.
7+
**Highcharts Core for Python** is a Python library that provides a Python wrapper
8+
for the `Highcharts Core <https://www.highcharts.com/products/highcharts/>`__ JavaScript data
9+
visualization library, with full integration into the robust Python ecosystem, including:
1010

11-
The toolkit is composed of several different libraries, each of which provides comprehensive support for a component of the Highcharts JS suite:
11+
* **Jupyter Labs/Notebook**. You can now produce high-end and interactive plots and
12+
renders using the full suite of Highcharts visualization capabilities.
13+
* **Pandas**. Automatically produce data visualizations from your Pandas dataframes
14+
* **PySpark**. Automatically produce data visualizations from data in a PySpark
15+
dataframe.
16+
* ...and even more use-case specific integrations across the broader toolkit.
17+
18+
**COMPLETE DOCUMENTATION:** https://core-docs.highchartspython.com/en/latest/index.html
19+
20+
-------------
21+
22+
***************************************
23+
The Highcharts for Python Toolkit
24+
***************************************
25+
26+
The **Highcharts Core for Python** library is - as the name suggests - the core library in
27+
the broader `Highcharts for Python Toolkit <https://www.highcharts.com/integrations/python>`__,
28+
which together provides comprehensive support across the entire
29+
`Highcharts <https://www.highcharts.com>`__ suite of data visualization libraries:
1230

1331
.. list-table::
1432
:widths: 30 30 40
@@ -22,29 +40,17 @@ The toolkit is composed of several different libraries, each of which provides c
2240
- (this library) the core Highcharts data visualization library
2341
* - `Highcharts Stock for Python <https://stock-docs.highchartspython.com/>`__
2442
- `Highcharts Stock (JS) <https://www.highcharts.com/products/stock/>`__
25-
- the robust time series visualization extension to Highcharts Core
43+
- the time series visualization extension to Highcharts Core
2644
* - `Highcharts Maps <https://maps-docs.highchartspython.com/>`__
2745
- `Highcharts Maps (JS) <https://www.highcharts.com/products/maps/>`__
28-
- the rich map visualization extension to Highcharts Core
46+
- the map visualization extension to Highcharts Core
2947
* - `Highcharts Gantt <https://gantt-docs.highchartspython.com/>`__
3048
- `Highcharts Gantt (JS) <https://www.highcharts.com/products/gantt/>`__
3149
- the Gantt charting extension to Highcharts Core
3250
* - (all libraries in the Python toolkit)
3351
- The **Highcharts Export Server**
3452
- enabling the programmatic creation of static (downloadable) data visualizations
3553

36-
In order to integrate **Highcharts for Python** into the Python ecosystem, the library
37-
features native integration with:
38-
39-
* **Jupyter Labs/Notebook**. You can now produce high-end and interactive plots and
40-
renders using the full suite of Highcharts visualization capabilities.
41-
* **Pandas**. Automatically produce data visualizations from your Pandas dataframes
42-
* **PySpark**. Automatically produce data visualizations from data in a PySpark
43-
dataframe.
44-
* ...and even more use-case specific integrations in each tool in the toolkit.
45-
46-
**COMPLETE DOCUMENTATION:** https://core-docs.highchartspython.com/en/latest/index.html
47-
4854
--------------------
4955

5056
***************
@@ -64,58 +70,60 @@ To install **Highcharts Core for Python**, just execute:
6470
Why Highcharts for Python?
6571
************************************
6672

67-
Odds are you are aware of `Highcharts JS <https://www.highcharts.com>`__. If not, why not?
68-
It is the world's most popular, most powerful, category-defining JavaScript data
69-
visualization library. If you are building a web or mobile app/dashboard that will be
70-
visualizing data in some fashion, you should absolutely take a look at the Highcharts
71-
suite of solutions. Just take a look at some of their fantastic
72-
`demo visualizations <https://www.highcharts.com/demo>`_.
73-
74-
`Highcharts JS <https://www.highcharts.com>`__ is a JavaScript library. It is written in
75-
JavaScript, and is specifically used to configure and render data visualizations in a
76-
web browser (or other JavaScript-executing) environment. As a JavaScript
77-
library, its audience is JavaScript developers. But what about the broader ecosystem of
73+
`Highcharts <https://www.highcharts.com>`__ is the world's most popular, most powerful,
74+
category-defining JavaScript data visualization library. If you are building a web or
75+
mobile app/dashboard that will be visualizing data in some fashion, you should
76+
absolutely take a look at the Highcharts suite of solutions. Take a peak at some
77+
fantastic `demo visualizations <https://www.highcharts.com/demo>`__.
78+
79+
As a suite of JavaScript libraries, `Highcharts <https://www.highcharts.com>`__ is
80+
written in JavaScript, and is used to configure and render data visualizations in a
81+
web browser (or other JavaScript-executing) environment. As a set of JavaScript
82+
libraries, its audience is JavaScript developers. But what about the broader ecosystem of
7883
Python developers and data scientists?
7984

80-
Python is increasingly used as the technology of choice for data science and for
81-
the backends of leading enterprise-grade applications. In other words, Python is
82-
often the backend that delivers data and content to the front-end...which then renders it
83-
using JavaScript and HTML.
85+
Given Python's increasing adoption as the technology of choice for data science and for
86+
the backends of leading enterprise-grade applications, Python is often the backend that
87+
delivers data and content to the front-end...which then renders it using JavaScript and
88+
HTML.
8489

8590
There are numerous Python frameworks (Django, Flask, Tornado, etc.) with specific
8691
capabilities to simplify integration with Javascript frontend frameworks (React, Angular,
8792
VueJS, etc.). But facilitating that with Highcharts has historically been very difficult.
8893
Part of this difficulty is because the Highcharts JavaScript suite - while supporting JSON as a
89-
serialization/deserialization format - leverages
90-
JavaScript object literals to expose the
94+
serialization/deserialization format - leverages JavaScript object literals to expose the
9195
full power and interactivity of its data visualizations. And while it's easy to serialize
9296
JSON from Python, serializing and deserializing to/from JavaScript object literal notation
93-
is much more complicated. This means that Python developers looking to integrate with
94-
Highcharts typically had to either invest a lot of effort, or were only able to leverage
95-
a small portion of Highcharts' rich functionality.
97+
is much more complicated.
9698

97-
So I wrote the **Highcharts for Python** toolkit to bridge that gap.
99+
This means that Python developers looking to integrate with Highcharts typically had to
100+
either invest a lot of effort, or were only able to leverage a small portion of Highcharts'
101+
rich functionality.
102+
103+
So we wrote the **Highcharts for Python** toolkit to bridge that gap.
98104

99105
**Highcharts for Python** provides Python object representation for *all* of the
100106
JavaScript objects defined in the
101-
`Highcharts JS API <https://api.highcharts.com/highcharts/>`__. It provides automatic data
102-
validation, and exposes simple and standardized methods for serializing those Python
107+
`Highcharts (JavaScript) API <https://api.highcharts.com/highcharts/>`__. It provides automatic
108+
data validation, and exposes simple and standardized methods for serializing those Python
103109
objects back-and-forth to JavaScript object literal notation.
104110

105-
Key Highcharts for Python Features
106-
======================================
111+
112+
Key Highcharts Core for Python Features
113+
===========================================
107114

108115
* **Clean and consistent API**. No reliance on "hacky" code, ``dict``
109116
and JSON serialization, or impossible to maintain / copy-pasted "spaghetti code".
110117
* **Comprehensive Highcharts Support**. Every single Highcharts chart type and every
111118
single configuration option is supported in the **Highcharts for Python** toolkit.
112-
This includes the over 70 data visualization types supported by
113-
`Highcharts JS <https://www.highcharts.com/product/highcharts/>`__ and the 50+
114-
technical indicator visualizations available in
115-
`Highcharts Stock <https://www.highcharts.com/product/stock/>`__, with full support for
116-
the rich JavaScript formatter (JS callback functions)
117-
capabilities that are often needed to get the most out of Highcharts' visualization and
118-
interaction capabilities.
119+
Highcharts Core for Python includes support for the over 70 data visualization types
120+
supported by `Highcharts Core <https://www.highcharts.com/product/highcharts/>`__ and
121+
while other libraries in the toolkit support the 50+ technical indicator visualizations
122+
available in `Highcharts Stock <https://www.highcharts.com/product/stock/>`__.
123+
124+
Every Highcharts for Python library provides full support for the rich JavaScript
125+
formatter (JS callback functions) capabilities that are often needed to get the most
126+
out of Highcharts' visualization and interaction capabilities.
119127

120128
.. note::
121129

@@ -128,13 +136,13 @@ Key Highcharts for Python Features
128136
capabilities.
129137
* **Easy and Robust Chart Download**. With one method call, produce high-end static
130138
visualizations that can be downloaded or shared as files with your audience. Produce
131-
static charts using the Highsoft-provided **Highcharts Export Server**, or using your own private export
132-
server as needed.
139+
static charts using the Highsoft-provided **Highcharts Export Server**, or using your
140+
own private export server as needed.
133141
* **Integration with Pandas and PySpark**. With two lines of code, produce a high-end
134142
interactive visualization of your Pandas or PySpark dataframe.
135143
* **Consistent code style**. For Python developers, switching between Pythonic code
136144
conventions and JavaScript code conventions can be...annoying. So
137-
**Highcharts for Python** applies Pythonic syntax with automatic conversion between
145+
the Highcharts for Python toolkit applies Pythonic syntax with automatic conversion between
138146
Pythonic ``snake_case`` notation and JavaScript ``camelCase`` styles.
139147

140148
|
@@ -343,8 +351,9 @@ that will render the chart wherever it is you want it to go:
343351
Getting Help/Support
344352
***********************
345353

346-
The **Highcharts for Python** toolkit comes with all of the great support that you are used to from working with the
347-
Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following tools to get
354+
The **Highcharts for Python** toolkit comes with all of the great support that
355+
you are used to from working with the Highcharts JavaScript libraries. When you
356+
license the toolkit, you are welcome to use any of the following tools to get
348357
help using the toolkit. In particular, you can:
349358

350359
* Use the `Highcharts Forums <https://highcharts.com/forum>`__
@@ -364,7 +373,8 @@ Contributing
364373
*********************
365374

366375
We welcome contributions and pull requests! For more information, please see the
367-
`Contributor Guide <https://core-docs.highchartspython.com/en/latest/contributing.html>`__. And thanks to all those who've already contributed!
376+
`Contributor Guide <https://core-docs.highchartspython.com/en/latest/contributing.html>`__.
377+
And thanks to all those who've already contributed!
368378

369379
-------------------
370380

docs/_dependencies.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
If these hard dependencies are not available in the environment where
1919
**Highcharts Core for Python** is running, then the library will simply not work. Besides
20-
Highcharts JS itself, all of the other hard dependencies are automatically installed
20+
Highcharts Core (JS) itself, all of the other hard dependencies are automatically installed
2121
when installing **Highcharts Core for Python** using:
2222

2323
.. code-block:: bash
@@ -29,7 +29,7 @@
2929
.. note::
3030

3131
Not technically a Python dependency, but obviously **Highcharts Core for Python** will
32-
not work properly if your rendering layer does not leverage Highcharts JS.
32+
not work properly if your rendering layer does not leverage Highcharts Core (JS).
3333

3434
* `esprima-python <https://github.com/Kronuz/esprima-python>`_ v.4.0 or higher
3535
* `requests <https://requests.readthedocs.io/en/latest/>`_ v.2.28 or higher

docs/_installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
To install **Highcharts for Python**, just execute:
1+
To install **Highcharts Core for Python**, just execute:
22

33
.. code-block:: bash
44

docs/_support.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
The **Highcharts for Python** toolkit comes with all of the great support that you are used to from working with the
2-
Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following tools to get
3-
help using the toolkit. In particular, you can:
1+
The **Highcharts for Python Toolkit** comes with all of the great support that you are used to from working with the
2+
Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following channels
3+
to get help using the toolkit. In particular, you can:
44

55
* Use the `Highcharts Forums <https://highcharts.com/forum>`__
66
* Use `Stack Overflow <https://stackoverflow.com/questions/tagged/highcharts-for-python>`__ with the
77
``highcharts-for-python`` tag
8-
* `Report bugs or request features <https://github.com/highcharts-for-python/highcharts-core/issues>`__ in the
9-
library's Github repository
10-
* `File a support ticket <https://www.highchartspython.com/get-help>`__ with us
8+
* `Report bugs or request features <https://github.com/highcharts-for-python/highcharts-core/issues>`__ in one of
9+
our Github repositories
10+
* `File a support ticket <https://www.highchartspython.com/get-help>`__ with us, or
1111
* `Schedule a live chat or video call <https://www.highchartspython.com/get-help>`__ with us
1212

13-
**FOR MORE INFORMATION:** https://www.highchartspython.com/get-help
13+
**FOR MORE INFORMATION:** https://www.highchartspython.com/get-help

0 commit comments

Comments
 (0)