Skip to content

Commit e1bb8b0

Browse files
committed
README and setup fixed
1 parent a5cd03b commit e1bb8b0

3 files changed

Lines changed: 24 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,32 @@
1010
from selenium_browser_desktop_recorder import SeleniumBrowserRecorder
1111

1212
Then you create a SeleniumBrowserRecorder object, you have two modes.
13+
1314
First mode:
1415

1516
obj = SeleniumBrowserRecorder(folder,encoding)
17+
1618
- folder: Folder where we want to create the folder that will contain the videos for our recording session
1719
- encoding: Encoding of the video. We only assure that using ".mp4" will work
1820
This way, when you start the recording session, the desktop will be recorded until we stop the recording session
1921

2022
But you can also provide a third parameter:
23+
2124
obj = SeleniumBrowserRecorder(folder,encoding,driver)
2225
- driver: A webdriver object
23-
In this case, we will record only the browser window(s) that are being controlled by that webdriver object
26+
27+
In this case, we will record only the browser window(s) that are being controlled by that webdriver object
2428

2529
To start the recording session once we build the object we only have to use this method:
26-
obj.startRecordingSession()
30+
31+
obj.start_recording_session()
32+
2733
And our object will start recording in a parallel thread
2834

2935
To stop the recording session we only have to:
30-
obj.stopRecordingSession()
36+
37+
obj.stop_recording_session()
38+
3139
The video will be saved and the threads finished
3240

3341
NOTE: If we are recording a browser and the size of it changes, we will stop the current video and start a new one with the new

pydesktopbrowerrecorder/README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,32 @@
1010
from selenium_browser_desktop_recorder import SeleniumBrowserRecorder
1111

1212
Then you create a SeleniumBrowserRecorder object, you have two modes.
13+
1314
First mode:
1415

1516
obj = SeleniumBrowserRecorder(folder,encoding)
17+
1618
- folder: Folder where we want to create the folder that will contain the videos for our recording session
1719
- encoding: Encoding of the video. We only assure that using ".mp4" will work
1820
This way, when you start the recording session, the desktop will be recorded until we stop the recording session
1921

2022
But you can also provide a third parameter:
23+
2124
obj = SeleniumBrowserRecorder(folder,encoding,driver)
2225
- driver: A webdriver object
23-
In this case, we will record only the browser window(s) that are being controlled by that webdriver object
26+
27+
In this case, we will record only the browser window(s) that are being controlled by that webdriver object
2428

2529
To start the recording session once we build the object we only have to use this method:
26-
obj.startRecordingSession()
30+
31+
obj.start_recording_session()
32+
2733
And our object will start recording in a parallel thread
2834

2935
To stop the recording session we only have to:
30-
obj.stopRecordingSession()
36+
37+
obj.stop_recording_session()
38+
3139
The video will be saved and the threads finished
3240

3341
NOTE: If we are recording a browser and the size of it changes, we will stop the current video and start a new one with the new

pydesktopbrowerrecorder/setup.cfg

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[metadata]
22
name = pydesktopbrowerrecorder
3-
version = 0.0.2
3+
version = 0.0.3
44
author = Antonio Pérez
5-
author_email = ingovanpee@gmail.com
5+
author_email = ingovanpe@gmail.com
66
description = Module to record videos of an automation session using Selenium webdriver or the desktop.
77
long_description = file: README.md
88
long_description_content_type = text/markdown

0 commit comments

Comments
 (0)