feat: Learned new command "simwrapper open [vsp/asim]"

simwrapper open [site] starts a local file server on port 800x AND
opens a new browser tab pointing to it.

Author: billyc

Makefile

@@ -32,9 +32,9 @@ push: build
 > twine upload dist/*
 .PHONY: push
 
-bump-version:
+version:
 > npx standard-version
-.PHONY: bump-version
+.PHONY: version
 
 #.build-sentinel: $(shell find simwrapper/*.py) $(shell find docs/*) README.md setup.py
 .build-sentinel: $(shell find simwrapper/*.py) README.md setup.py

README.md

@@ -13,10 +13,16 @@ We are at the very early stages of building this tool. The API will change, thin
 - Our primary goal is to make it easy to get local simulation results viewable using the SimWrapper website.
 - We have only tested this using Anaconda Python. Only Python 3.x is supported.
 
-## Quickstart
+## Installation
 
-1. Install once, using `pip install simwrapper`
+Install once, using `pip install simwrapper`
 
-2. `cd` into your data folder, then run `simwrapper serve` to enable the local file server
+## Usage
 
-3. Browse to either <https://vsp.berlin/simwrapper> or <https://activitysim.github.io/dashboard> to view your local folder outputs.
+`simwrapper` knows two commands:
+
+- `simwrapper serve` starts a local file server in the current directory. Run this command, then browse to either <https://vsp.berlin/simwrapper> or <https://activitysim.github.io/dashboard> to view your local folder outputs.
+
+- `simwrapper open [vsp|asim]` opens a new web browser tab AND a local file server in the current directory. The site will only operate as long as you keep that local server running, so don't close the command window.
+  - For the ActivitySim site, use `simwrapper open asim`
+  - For the VSP MATSim site, use `simwrapper open vsp`

simwrapper/MiniFileServer.py

@@ -125,7 +125,6 @@ def find_free_port(port):
         try:
             s.bind(('', i))
             s.close()
-            print("Found free port:",i)
             return i
 
         except:
@@ -135,7 +134,8 @@ def find_free_port(port):
 
 def run_mini_file_server(port):
     print("\n-----------------------------------------------------------------")
-    print("SimWrapper file server:", os.getcwd())
+    print("SimWrapper file server: port", port)
+    print(os.getcwd())
 
     free_port = find_free_port(port)
 

simwrapper/cli.py

@@ -1,21 +1,38 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-# click makes building cmdline tools easy, see docs at
-# https://click.palletsprojects.com/en/8.0.x
+import click       # cmdline generator! https://click.palletsprojects.com/en/8.0.x
+import webbrowser
+import os
 
-import click
+from . import sites
 from . import MiniFileServer
 
+default_port = 8000
+
 @click.group()
 def cli():
-  pass
+    pass
 
 @cli.command(help="Start a local file server in this folder")
-@click.argument('port', default=8000)
+@click.argument('port', default=default_port)
 def serve(port):
-  MiniFileServer.run_mini_file_server(port)
+    MiniFileServer.run_mini_file_server(port)
+
+@cli.command(help="Open your browser and view this folder using SimWrapper")
+@click.argument('site', default='vsp')
+def open(site):
+    port = MiniFileServer.find_free_port(default_port)
+    # Build the full URL for this site, including the free port number
+    url = ''
+    if site in sites.sites:
+      url = os.path.join(sites.sites[site],str(port))
+    else:
+      url = os.path.join(site,str(port))
+
+    # Open web browser first, because this command returns immediately
+    print("Opening:", url)
+    webbrowser.open(url, new=2, autoraise=True)  # in a new tab
 
-# @cli.command(help="Open your browser and view files in this folder")
-# def browse():
-#   click.echo("OPEN!!")
+    # Then start local fileserver
+    MiniFileServer.run_mini_file_server(port)

simwrapper/sites.py

@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+# Add more SimWrapper sites here:
+
+sites = {
+  "vsp": "https://vsp.berlin/simwrapper/",
+  "asim": "https://activitysim.github.io/dashboard/"
+}