https://github.com/westurner/web.sh

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)
https://github.com/westurner/web.sh

browser-detection command-line-tool python-script

Last synced: about 1 year ago
JSON representation

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)

• Host: GitHub
• URL: https://github.com/westurner/web.sh
• Owner: westurner
• License: bsd-3-clause
• Created: 2015-06-22T05:20:20.000Z (almost 11 years ago)
• Default Branch: develop
• Last Pushed: 2015-06-22T11:12:23.000Z (almost 11 years ago)
• Last Synced: 2024-09-19T08:38:23.545Z (over 1 year ago)
• Topics: browser-detection, command-line-tool, python-script
• Language: Python
• Homepage: https://pypi.python.org/pypi/web.sh
• Size: 160 KB
• Stars: 2
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
===============================

web.sh

===============================

.. image:: https://img.shields.io/travis/westurner/web.sh.svg

        :target: https://travis-ci.org/westurner/web.sh

.. image:: https://img.shields.io/pypi/v/web.sh.svg

        :target: https://pypi.python.org/pypi/web.sh

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``)

* Free software: BSD license

* PyPI: https://pypi.python.org/pypi/web.sh

* Warehouse: https://warehouse.python.org/project/web.sh

* Source: https://github.com/westurner/web.sh

.. contents::

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:

.. code:: bash

   pip install web.sh

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

Usage

-------

The ``web`` script commandline interface:

.. code:: bash

    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]  []

    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 `` calls ``websh.websh.WebBrowser.x_www_browser``

  to open new tabs for each path or URI:

  .. code:: python

      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