|
| 1 | +################################ |
| 2 | +Demos |
| 3 | +################################ |
| 4 | + |
| 5 | +.. contents:: |
| 6 | + :depth: 2 |
| 7 | + :backlinks: entry |
| 8 | + |
| 9 | +------------------- |
| 10 | + |
| 11 | +*********************************************** |
| 12 | +Trying the Highcharts for Python Toolkit |
| 13 | +*********************************************** |
| 14 | + |
| 15 | +You are welcome to try the **Highcharts for Python** toolkit at your convenience and at no cost. |
| 16 | +You can do so by installing the libraries you need very simple: |
| 17 | + |
| 18 | +.. tabs:: |
| 19 | + |
| 20 | + .. tab:: Highcharts Core for Python |
| 21 | + |
| 22 | + To install **Highcharts Core for Python**, just execute: |
| 23 | + |
| 24 | + .. code-block:: bash |
| 25 | +
|
| 26 | + $ pip install highcharts-core |
| 27 | +
|
| 28 | + .. tab:: Highcharts Stock for Python |
| 29 | + |
| 30 | + To install **Highcharts Stock for Python**, just execute: |
| 31 | + |
| 32 | + .. code-block:: bash |
| 33 | +
|
| 34 | + $ pip install highcharts-stock |
| 35 | +
|
| 36 | + .. tab:: Highcharts Maps for Python |
| 37 | + |
| 38 | + To install **Highcharts Maps for Python**, just execute: |
| 39 | + |
| 40 | + .. code-block:: bash |
| 41 | +
|
| 42 | + $ pip install highcharts-maps |
| 43 | +
|
| 44 | + .. tab:: Highcharts Gantt for Python |
| 45 | + |
| 46 | + To install **Highcharts Gantt for Python**, just execute: |
| 47 | + |
| 48 | + .. code-block:: bash |
| 49 | +
|
| 50 | + $ pip install highcharts-gantt |
| 51 | +
|
| 52 | +If you are evaluating the **Highcharts for Python Toolkit**, you are welcome |
| 53 | +to install this library and use it free of charge. |
| 54 | + |
| 55 | +However, if you are using it for professional purposes - either to use |
| 56 | +Highcharts for your work, or to build an application that integrates the library - |
| 57 | +then you have to pay for both Highcharts Core (JS) itself *and* for your right |
| 58 | +to use the **Highcharts for Python Toolkit**. |
| 59 | + |
| 60 | +You can purchase licenses for both from Highsoft A/S at: |
| 61 | +`https://shop.highcharts.com/ <https://shop.highcharts.com>`__. |
| 62 | + |
| 63 | +--------------- |
| 64 | + |
| 65 | +******************************************************** |
| 66 | +Demonstrating the Highcharts for Python Toolkit |
| 67 | +******************************************************** |
| 68 | + |
| 69 | +We have prepared an extensive set of demos showcasing much of the code and |
| 70 | +functionality of the **Highcharts for Python** toolkit. To see the demos in action, |
| 71 | +we recommend that you click the following badge: |
| 72 | + |
| 73 | + .. image:: https://mybinder.org/badge_logo.svg |
| 74 | + :target: https://mybinder.org/v2/gh/highcharts-for-python/highcharts-for-python-demos/HEAD |
| 75 | + :alt: Binder: Highcharts for Python Demos |
| 76 | + |
| 77 | +This will clone the `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__ |
| 78 | +source repository within a Docker image, and launch `Jupyter Lab <https://jupyter.org>`__ within that |
| 79 | +Docker container. This will then let you browse, edit, and run any of the Jupyter Notebooks contained |
| 80 | +within the `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__ repo. |
| 81 | + |
| 82 | +How the Demos are Organized |
| 83 | +============================== |
| 84 | + |
| 85 | +.. sidebar:: |
| 86 | + |
| 87 | + You should be aware that the demos use a variety of Highcharts for Python features, including various |
| 88 | + ways of de-serializing chart configurations. Some might load data from files, others might load them |
| 89 | + from ``snake_case`` :class:`dict <python:dict>`, others from ``camelCase`` Javascript Object Literal |
| 90 | + Notation :class:`str <python:str>` values, and more. |
| 91 | + |
| 92 | + To see the full flexibility that the toolkit provides, we recommend reviewing several of the demos. |
| 93 | + |
| 94 | +Once you have launched the Binder, you can browse the folders and Notebooks in the Jupyter Lab |
| 95 | +environment. You'll notice that the Jupyter Lab environment has one folder for each of the core |
| 96 | +Highcharts for Python libraries, respectively: ``highcharts-core``, ``highcharts-stock``, |
| 97 | +``highcharts-maps``, and ``highcharts-gantt``. Within each of these folders, you will find sub-folders |
| 98 | +labeled in a way to describe their contents. |
| 99 | + |
| 100 | +For example: |
| 101 | + |
| 102 | + * the sub-folder ``line-charts`` would contain various Notebooks that demonstrate the |
| 103 | + generation of various Line Charts using the **Highcharts for Python** toolkit |
| 104 | + * the sub-folder ``python-features`` would contain various Notebooks that demonstrate |
| 105 | + the use of Python-specific features like the ``.from_pandas()`` convenience methods |
| 106 | + * etc. |
| 107 | + |
| 108 | +Navigating the demos should be fairly intuitive - just pay attention to the folder names and the filenames of the Jupyter Notebooks. |
| 109 | + |
| 110 | +Executing a Demo |
| 111 | +=================== |
| 112 | + |
| 113 | +Once you are reviewing the demos, you can run a demo either by stepping through the cells in the Notebook, or |
| 114 | +by running all the cells in sequence. |
| 115 | + |
| 116 | +------------------ |
| 117 | + |
| 118 | +******************************* |
| 119 | +Running Demos Locally |
| 120 | +******************************* |
| 121 | + |
| 122 | +.. info:: |
| 123 | + |
| 124 | + You can run the demos locally by following instructions in the |
| 125 | + `Highcharts for Python Demos <https://github.com/highcharts-for-python-demos>`__ Github repo's README. |
0 commit comments