Skip to content

Updated License and code snippet in README #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016 BrowserStack
Copyright (c) 2019 BrowserStack

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Python bindings for BrowserStack Local.

## Installation

```
```sh
pip install browserstack-local
```

## Example

```
```python
from browserstack.local import Local

#creates an instance of Local
Expand All @@ -25,7 +25,7 @@ bs_local_args = { "key": "" }
bs_local.start(**bs_local_args)

#check if BrowserStack local instance is running
print bs_local.isRunning()
print(bs_local.isRunning())

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

#### Verbose Logging
To enable verbose logging -
```
```sh
bs_local_args = { "key": "" , "v": "true"}
```

#### Folder Testing
To test local folder rather internal server, provide path to folder as value of this option -
```
```sh
bs_local_args = { "key": "" , "f": "/my/awesome/folder"}
```

#### Force Start
To kill other running Browserstack Local instances -
```
```sh
bs_local_args = { "key": "" , "force": "true"}
```

#### Only Automate
To disable local testing for Live and Screenshots, and enable only Automate -
```
```sh
bs_local_args = { "key": "" , "onlyAutomate": "true"}
```

#### Force Local
To route all traffic via local(your) machine -
```
```sh
bs_local_args = { "key": "" , "forcelocal": "true"}
```

Expand All @@ -74,13 +74,13 @@ To use a proxy for local testing -
* proxyUser: Username for connecting to proxy (Basic Auth Only)
* proxyPass: Password for USERNAME, will be ignored if USERNAME is empty or not specified

```
```sh
bs_local_args = { "key": "", "proxyHost": "127.0.0.1", "proxyPort": "8000", "proxyUser": "user", "proxyPass": "password"}
```

#### Local Identifier
If doing simultaneous multiple local testing connections, set this uniquely for different processes -
```
```sh
bs_local_args = { "key": "" , "localIdentifier": "randomstring"}
```

Expand All @@ -90,14 +90,14 @@ bs_local_args = { "key": "" , "localIdentifier": "random

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.
Path to specify local Binary path -
```
```sh
bs_local_args = { "key": "" , "binarypath": "/browserstack/BrowserStackLocal"}
```

#### Logfile
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.
To specify the path to file where the logs will be saved -
```
```sh
bs_local_args = { "key": "" , "v": "true", "logfile": "/browserstack/logs.txt"}
```

Expand Down