Skip to content

Commit 7b21e6c

Browse files
committed
Preliminary demo commit.
1 parent 1f3ae9a commit 7b21e6c

File tree

3 files changed

+654
-2
lines changed

3 files changed

+654
-2
lines changed

README.md

Lines changed: 57 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,57 @@
1-
# highcharts-for-python-demos
2-
Collection of demo visualizations using the Highcharts for Python toolkit
1+
# Highcharts for Python Demos
2+
This is a collection of demonstrations of the Highcharts for Python toolkit.
3+
Fundamentally, they are a Python port of the fantastic demos that Highsoft has
4+
already published for their
5+
[Highcharts JavaScript library](https://www.highcharts.com/demo).
6+
7+
## How to Use the Demos
8+
First, clone this Github repo:
9+
10+
```
11+
$ git clone [email protected]:highcharts-for-python/highcharts-for-python-demos.git
12+
```
13+
14+
Next, navigate to its directory:
15+
16+
```
17+
$ cd highcharts-for-python-demos
18+
19+
highcharts-for-python-demos/ (master)
20+
$
21+
````
22+
23+
Create a virtual environment:
24+
25+
```
26+
highcharts-for-python-demos/ (master)
27+
$ python -m venv .venv
28+
```
29+
30+
Then activate your virtual environment:
31+
32+
```
33+
highcharts-for-python-demos/ (master)
34+
$ source .venv/Scripts/activate
35+
36+
(.venv)
37+
highcharts-for-python-demos/ (master)
38+
$
39+
```
40+
41+
and install the requirements:
42+
43+
```
44+
(.venv)
45+
highcharts-for-python-demos/ (master)
46+
$ pip install -r requirements.txt
47+
```
48+
49+
And finally, open up Jupyter Lab:
50+
51+
```
52+
(.venv)
53+
highcharts-for-python-demos/ (master)
54+
$ jupyter-lab
55+
```
56+
57+
You should now see the set of notebooks included in the repo, along with relevant data files and other details. Browse through the repo, and look at the demos that you want to see. It should be fairly self-explanatory!

0 commit comments

Comments
 (0)