Skip to content

Commit 088e81e

Browse files
committed
Updated License and code snippet in README
1 parent 16439c9 commit 088e81e

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

Diff for: LICENSE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2016 BrowserStack
3+
Copyright (c) 2019 BrowserStack
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

Diff for: README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Python bindings for BrowserStack Local.
66

77
## Installation
88

9-
```
9+
```sh
1010
pip install browserstack-local
1111
```
1212

1313
## Example
1414

15-
```
15+
```python
1616
from browserstack.local import Local
1717

1818
#creates an instance of Local
@@ -25,7 +25,7 @@ bs_local_args = { "key": "<browserstack-accesskey>" }
2525
bs_local.start(**bs_local_args)
2626

2727
#check if BrowserStack local instance is running
28-
print bs_local.isRunning()
28+
print(bs_local.isRunning())
2929

3030
#stop the Local instance
3131
bs_local.stop()
@@ -38,31 +38,31 @@ Apart from the key, all other BrowserStack Local modifiers are optional. For the
3838

3939
#### Verbose Logging
4040
To enable verbose logging -
41-
```
41+
```sh
4242
bs_local_args = { "key": "<browserstack-accesskey>" , "v": "true"}
4343
```
4444
4545
#### Folder Testing
4646
To test local folder rather internal server, provide path to folder as value of this option -
47-
```
47+
```sh
4848
bs_local_args = { "key": "<browserstack-accesskey>" , "f": "/my/awesome/folder"}
4949
```
5050
5151
#### Force Start
5252
To kill other running Browserstack Local instances -
53-
```
53+
```sh
5454
bs_local_args = { "key": "<browserstack-accesskey>" , "force": "true"}
5555
```
5656
5757
#### Only Automate
5858
To disable local testing for Live and Screenshots, and enable only Automate -
59-
```
59+
```sh
6060
bs_local_args = { "key": "<browserstack-accesskey>" , "onlyAutomate": "true"}
6161
```
6262
6363
#### Force Local
6464
To route all traffic via local(your) machine -
65-
```
65+
```sh
6666
bs_local_args = { "key": "<browserstack-accesskey>" , "forcelocal": "true"}
6767
```
6868
@@ -74,13 +74,13 @@ To use a proxy for local testing -
7474
* proxyUser: Username for connecting to proxy (Basic Auth Only)
7575
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified
7676
77-
```
77+
```sh
7878
bs_local_args = { "key": "<browserstack-accesskey>", "proxyHost": "127.0.0.1", "proxyPort": "8000", "proxyUser": "user", "proxyPass": "password"}
7979
```
8080
8181
#### Local Identifier
8282
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
83-
```
83+
```sh
8484
bs_local_args = { "key": "<browserstack-accesskey>" , "localIdentifier": "randomstring"}
8585
```
8686
@@ -90,14 +90,14 @@ bs_local_args = { "key": "<browserstack-accesskey>" , "localIdentifier": "random
9090
9191
By default, BrowserStack local wrappers try downloading and executing the latest version of BrowserStack binary in ~/.browserstack or the present working directory or the tmp folder by order. But you can override these by passing the -binarypath argument.
9292
Path to specify local Binary path -
93-
```
93+
```sh
9494
bs_local_args = { "key": "<browserstack-accesskey>" , "binarypath": "/browserstack/BrowserStackLocal"}
9595
```
9696
9797
#### Logfile
9898
To save the logs to the file while running with the '-v' argument, you can specify the path of the file. By default the logs are saved in the local.log file in the present woring directory.
9999
To specify the path to file where the logs will be saved -
100-
```
100+
```sh
101101
bs_local_args = { "key": "<browserstack-accesskey>" , "v": "true", "logfile": "/browserstack/logs.txt"}
102102
```
103103

0 commit comments

Comments
 (0)