Skip to content

Commit

Permalink
Minor docs updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
ljhopkins2 committed Jan 8, 2020
1 parent 191c9e2 commit e579b8c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/user-guide/creating-an-archive.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ BroadcastifyArchive(feed_id=None,
| Parameter | Data Type | Requirement | Description |
|:----------|:----------|:------------|:------------|
| `feed_id` | str | Required | The unique feed identifier for the Broadcastify feed represented by the object, taken from www.broadcastify.com/listen/feed/[feed_id]|
| `username` | str | Optional | The username for a valid Broadcastify account. In order to download, the account must be a [premium account](https://m.broadcastify.com/premium/). (The parameter is optional at instantiation, but must be set before downloading audio files) |
| `password` | str | Optional | The password for the account referenced by `username`, and is subject to the same requirement timing |
| `login_cfg_path` | str | Optional | Absolute path to [a config file](#password-configuration-files) containing the username and password information. Allows the user to maintain the privacy of their account information by by keeping it outside the code using the toolkit |
| `username` | str | Optional | The username for a valid Broadcastify account. In order to download, the account must be a [premium account](https://m.broadcastify.com/premium/). (The parameter is optional at instantiation, but must be set before downloading audio files, unless `login_cfg_path` is supplied) |
| `password` | str | Optional | The password for the account referenced by `username`; required subject to the same constraints and timing as `username`|
| `login_cfg_path` | str | Optional | Absolute path to [a config file](#password-configuration-files) containing the username and password information. Allows the user to maintain the privacy of their account information |
| `show_browser_ui` | bool | Optional | If True, scraping done during initialization and build will be done with the Selenium webdriver option `headless=False`, resulting in a visible browser window being open in the UI during scraping. Otherwise, scraping will be done "invisibly". Note that no browser will be shown during download, since `requests.Session()` is used rather than Selenium |
| `webdriver_path` | str | Optional | The absolute path to the Selenium webdriver to be used for scraping. Not required if the WebDriver is in a directory in the operating system's `PATH` environment variable. The path must be to the WebDriver file itself, not the containing directory |

Expand Down

0 comments on commit e579b8c

Please sign in to comment.