Skip to content

westurner/web.sh

Repository files navigation

web.sh

image

image

web.sh is a cross-platform script (web) and API for launching a browser (with x-www-browser (Linux, Unix), open (OSX), start (Windows), or python -m webbrowser)

Features

  • Open the configured default system web browser with one or more paths or URIs
  • Open to a relative path
  • Open to an absolute path

Installation

Install the web (and x-www-browser-) scripts:

pip install web.sh
pip install -e https://github.com/westurner/web.sh

Usage

The web script commandline interface:

web .
web ./index.html
web $WORKON_HOME/dotfiles/src/dotfiles/docs/_build/html/index.html
web localhost:8082   #  pgs docs/_build/html  # pypi:pgs
web https://westurner.org/dotfiles/
web westurner.org/dotfiles github.com/westurner/dotfiles  # !HTTPS!
x-www-browser- .

web --help commandline help:

Usage: websh.py [-b|-x|-o|-s] [-v|-q] <url1> [<url_n>]

Open paths or URIS as tabs in the configured system default webbrowser

Options:
  -h, --help           show this help message and exit
  -b, --webbrowser     Open with `python -m webbrowser`
  -x, --x-www-browser  Open with `x-www-browser` (Linux, X)
  -o, --open           Open with `open` (OSX)
  -s, --start          Open with `start` (Windows)
  -v, --verbose        
  -q, --quiet          
  -t, --test          

API

  • Instances of websh.websh.WebBrowser implement open_new_tab()
  • websh.websh.WebBrowser.x_www_browser calls open_new_tab() with a list of paths and/or URIs
  • web <urls> calls websh.websh.WebBrowser.x_www_browser to open new tabs for each path or URI:

    urls = (["https://westurner.org/dotfiles/",
             "https://github.com/westurner/dotfiles",
             "https://waffle.io/westurner/dotfiles"])
    output = list(WebBrowser.x_www_browser(urls))
    print(output)

Platform Notes

  • OSX: web -o ./README.rst and web -b ./README.rst open README.rst in the configured editor (not the configured system browser).

    Workarounds:

    • Specify the full path to a specific browser application followed by a quoted URI, for each URI in a newline-delimited list

About

web.sh is a python script ($ web (websh.py)) and API for launching a browser (with x-www-browser (Linux, Unix), open (OSX), start (Windows), or python -m webbrowser)

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published