Merge pull request #637 from seleniumbase/improve-chart-maker

Add the ability to create bar charts and column charts with Chart Maker

Author: mdmintz

.gitignore

@@ -23,6 +23,10 @@ env
 venv
 sbase
 sbase*
+seleniumbase_env
+seleniumbase_venv
+sbase_env
+sbase_venv
 pyvenv.cfg
 .Python
 include

examples/chart_maker/ReadMe.md

@@ -4,26 +4,68 @@
 
 SeleniumBase Chart Maker allows you to create HTML charts with Python.<br />
 The HighCharts library is used for creating charts.
-(Currently only <b>pie charts</b> are supported.)
 
 **Here's a sample chart:**
 
 <a href="https://seleniumbase.io/other/chart_presentation.html"><img width="500" src="https://seleniumbase.io/other/sample_pie_chart.png" title="Screenshot"></a><br>
 
 ([Click on the image for the actual chart](https://seleniumbase.io/other/chart_presentation.html))
 
-Here's how to run the example (a chart in a presentation):
-```
+Here's how to run the example (multiple charts in a presentation):
+
+```bash
 cd examples/chart_maker
 pytest my_chart.py
 ```
 
+(Press the Right Arrow to advance to the next slide in the chart presentation)
+
 
 ### Creating a new chart:
 
 ```python
-self.create_pie_chart(chart_name=None, title="My Chart")
-""" Creates a JavaScript pie chart using "HighCharts". """
+self.create_pie_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript pie chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
+```
+
+```python
+self.create_bar_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript bar chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
+```
+
+```python
+self.create_column_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript column chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
 ```
 
 If creating multiple charts at the same time, you can pass the ``chart_name`` parameter to distinguish between different charts.
@@ -87,26 +129,38 @@ self.display_chart(chart_name=None, filename=None):
 """
 ```
 
-All methods have the optional ``chart_name`` argument, which is only needed if you're creating multiple charts at once.
+All methods have the optional ``chart_name`` argument, which is only needed if you're creating multiple charts at the same time.
 
 
 ### Here's an example of using SeleniumBase Chart Maker:
 
 ```python
 from seleniumbase import BaseCase
 
-
 class MyChartMakerClass(BaseCase):
 
     def test_chart_maker(self):
+        self.create_presentation()
+
         self.create_pie_chart(title="Automated Tests")
         self.add_data_point("Passed", 7, color="#95d96f")
         self.add_data_point("Untested", 2, color="#eaeaea")
         self.add_data_point("Failed", 1, color="#f1888f")
-        self.create_presentation()
         self.add_slide(self.extract_chart())
-        self.begin_presentation()
 
+        self.create_bar_chart(title="Code", libs=False)
+        self.add_data_point("Python", 33, color="Orange")
+        self.add_data_point("JavaScript", 27, color="Teal")
+        self.add_data_point("HTML + CSS", 21, color="Purple")
+        self.add_slide(self.extract_chart())
+
+        self.create_column_chart(title="Colors", libs=False)
+        self.add_data_point("Red", 10, color="Red")
+        self.add_data_point("Green", 25, color="Green")
+        self.add_data_point("Blue", 15, color="Blue")
+        self.add_slide(self.extract_chart())
+
+        self.begin_presentation()
 ```
 
 #### This example is from [my_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/my_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:

examples/chart_maker/my_chart.py

@@ -4,10 +4,24 @@
 class MyChartMakerClass(BaseCase):
 
     def test_chart_maker(self):
+        self.create_presentation()
+
         self.create_pie_chart(title="Automated Tests")
         self.add_data_point("Passed", 7, color="#95d96f")
         self.add_data_point("Untested", 2, color="#eaeaea")
         self.add_data_point("Failed", 1, color="#f1888f")
-        self.create_presentation()
         self.add_slide(self.extract_chart())
+
+        self.create_bar_chart(title="Code", libs=False)
+        self.add_data_point("Python", 33, color="Orange")
+        self.add_data_point("JavaScript", 27, color="Teal")
+        self.add_data_point("HTML + CSS", 21, color="Purple")
+        self.add_slide(self.extract_chart())
+
+        self.create_column_chart(title="Colors", libs=False)
+        self.add_data_point("Red", 10, color="Red")
+        self.add_data_point("Green", 25, color="Green")
+        self.add_data_point("Blue", 15, color="Blue")
+        self.add_slide(self.extract_chart())
+
         self.begin_presentation()

help_docs/chart_maker.md

@@ -4,26 +4,68 @@
 
 SeleniumBase Chart Maker allows you to create HTML charts with Python.<br />
 The HighCharts library is used for creating charts.
-(Currently only <b>pie charts</b> are supported.)
 
 **Here's a sample chart:**
 
 <a href="https://seleniumbase.io/other/chart_presentation.html"><img width="500" src="https://seleniumbase.io/other/sample_pie_chart.png" title="Screenshot"></a><br>
 
 ([Click on the image for the actual chart](https://seleniumbase.io/other/chart_presentation.html))
 
-Here's how to run the example (a chart in a presentation):
-```
+Here's how to run the example (multiple charts in a presentation):
+
+```bash
 cd examples/chart_maker
 pytest my_chart.py
 ```
 
+(Press the Right Arrow to advance to the next slide in the chart presentation)
+
 
 ### Creating a new chart:
 
 ```python
-self.create_pie_chart(chart_name=None, title="My Chart")
-""" Creates a JavaScript pie chart using "HighCharts". """
+self.create_pie_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript pie chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
+```
+
+```python
+self.create_bar_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript bar chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
+```
+
+```python
+self.create_column_chart(chart_name=None, title="My Chart", libs=True)
+""" Creates a JavaScript column chart using "HighCharts".
+    @Params
+    chart_name - If creating multiple charts,
+                 use this to select which one.
+    title - The title displayed for the chart.
+    libs - The option to include Chart libraries (JS and CSS files).
+           Should be set to True (default) for the first time creating
+           a chart on a web page. If creating multiple charts on
+           a web page, you no longer need to re-import the libraries
+           when creating additional charts.
+"""
 ```
 
 If creating multiple charts at the same time, you can pass the ``chart_name`` parameter to distinguish between different charts.
@@ -87,26 +129,38 @@ self.display_chart(chart_name=None, filename=None):
 """
 ```
 
-All methods have the optional ``chart_name`` argument, which is only needed if you're creating multiple charts at once.
+All methods have the optional ``chart_name`` argument, which is only needed if you're creating multiple charts at the same time.
 
 
 ### Here's an example of using SeleniumBase Chart Maker:
 
 ```python
 from seleniumbase import BaseCase
 
-
 class MyChartMakerClass(BaseCase):
 
     def test_chart_maker(self):
+        self.create_presentation()
+
         self.create_pie_chart(title="Automated Tests")
         self.add_data_point("Passed", 7, color="#95d96f")
         self.add_data_point("Untested", 2, color="#eaeaea")
         self.add_data_point("Failed", 1, color="#f1888f")
-        self.create_presentation()
         self.add_slide(self.extract_chart())
-        self.begin_presentation()
 
+        self.create_bar_chart(title="Code", libs=False)
+        self.add_data_point("Python", 33, color="Orange")
+        self.add_data_point("JavaScript", 27, color="Teal")
+        self.add_data_point("HTML + CSS", 21, color="Purple")
+        self.add_slide(self.extract_chart())
+
+        self.create_column_chart(title="Colors", libs=False)
+        self.add_data_point("Red", 10, color="Red")
+        self.add_data_point("Green", 25, color="Green")
+        self.add_data_point("Blue", 15, color="Blue")
+        self.add_slide(self.extract_chart())
+
+        self.begin_presentation()
 ```
 
 #### This example is from [my_chart.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/my_chart.py), which you can run from the ``examples/chart_maker`` folder with the following command:

help_docs/method_summary.md

@@ -371,7 +371,11 @@ self.begin_presentation(name=None, filename=None, show_notes=False, interval=0)
 
 ############
 
-self.create_pie_chart(chart_name=None, title=None)
+self.create_pie_chart(chart_name=None, title=None, libs=True)
+
+self.create_bar_chart(chart_name=None, title=None, libs=True)
+
+self.create_column_chart(chart_name=None, title=None, libs=True)
 
 self.add_data_point(label, value, color=None, chart_name=None)
 

requirements.txt

@@ -43,7 +43,7 @@ coverage==5.2.1
 brython>=3.8.9
 pyotp==2.3.0
 boto==2.49.0
-cffi==1.14.0
+cffi==1.14.1
 rich==4.1.0;python_version>="3.6" and python_version<"4.0"
 flake8==3.7.9;python_version<"3.5"
 flake8==3.8.3;python_version>="3.5"

seleniumbase/console_scripts/sb_mkdir.py

@@ -147,6 +147,10 @@ def main():
     data.append("venv")
     data.append("sbase")
     data.append("sbase*")
+    data.append("seleniumbase_env")
+    data.append("seleniumbase_venv")
+    data.append("sbase_env")
+    data.append("sbase_venv")
     data.append("pyvenv.cfg")
     data.append(".Python")
     data.append("include")