modularize

Author: scivision

.flake8

@@ -1,3 +1,5 @@
 [flake8]
 max-line-length = 132
 exclude = .git,__pycache__,.eggs/,doc/,docs/,build/,dist/,archive/
+per-file-ignores =
+    __init__.py:F401

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at info@scivision.dev. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

MozLoc.py

@@ -7,7 +7,7 @@
 
 Uses ``nmcli`` from Linux only. Could be extended to other tools and OS.
 """
-from mozloc import logwifiloc
+from mozloc import log_wifi_loc
 from argparse import ArgumentParser
 
 
@@ -16,13 +16,14 @@ def main():
     output: lat lon [deg] accuracy [m]
     """
     p = ArgumentParser()
-    p.add_argument('logfile', help='logfile to append location to', nargs='?')
-    p.add_argument('-T', '--cadence', help='how often to ping [sec]. Some laptops cannot go faster than 30 sec.',
-                   default=60, type=float)
+    p.add_argument("logfile", help="logfile to append location to", nargs="?")
+    p.add_argument(
+        "-T", "--cadence", help="how often to ping [sec]. Some laptops cannot go faster than 30 sec.", default=60, type=float
+    )
     p = p.parse_args()
 
-    logwifiloc(p.cadence, p.logfile)
+    log_wifi_loc(p.cadence, p.logfile)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

csv2kml.py

@@ -1,17 +1,17 @@
 #!/usr/bin/env python
 """convert logged positions to KML"""
-from mozloc import csv2kml
+from mozloc.utils import csv2kml
 from argparse import ArgumentParser
 
 
 def main():
     p = ArgumentParser()
-    p.add_argument('logfn', help='csv logfile to read')
-    p.add_argument('kmlfn', help='kml filename to write')
+    p.add_argument("logfn", help="csv logfile to read")
+    p.add_argument("kmlfn", help="kml filename to write")
     p = p.parse_args()
 
     csv2kml(p.logfn, p.kmlfn)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

mozloc/__init__.py

@@ -1,135 +1 @@
-import subprocess
-import logging
-from io import StringIO
-import pandas
-import requests
-import shutil
-from datetime import datetime
-from time import sleep
-from pathlib import Path
-from typing import Dict, Any, Optional
-
-NMCLI = shutil.which('nmcli')
-if not NMCLI:
-    raise ImportError('This program relies on NetworkManager via "nmcli"')
-
-URL = 'https://location.services.mozilla.com/v1/geolocate?key=test'
-NMCMD = [NMCLI, '-g', 'SSID,BSSID,FREQ,SIGNAL', 'device', 'wifi']  # Debian stretch, Ubuntu 18.04
-NMLEG = [NMCLI, '-t', '-f', 'SSID,BSSID,FREQ,SIGNAL', 'device', 'wifi']  # ubuntu 16.04
-NMSCAN = [NMCLI, 'device', 'wifi', 'rescan']
-HEADER = 'time lat lon accuracy NumBSSIDs'
-
-# %%
-
-
-def logwifiloc(T: float, logfile: Path):
-
-    if logfile:
-        logfile = Path(logfile).expanduser()
-        with logfile.open('a') as f:
-            f.write(HEADER+'\n')
-
-    print(f'updating every {T} seconds')
-    print(HEADER)
-
-    nm_config_check()
-    sleep(0.5)  # nmcli errored for less than about 0.2 sec.
-    while True:
-        loc = get_nmcli()
-        if loc is None:
-            sleep(T)
-            continue
-
-        stat = f'{loc["t"].isoformat(timespec="seconds")} {loc["lat"]} {loc["lng"]} {loc["accuracy"]:.1f} {loc["N"]:02d}'
-        print(stat)
-
-        if logfile:
-            with logfile.open('a') as f:
-                f.write(stat+'\n')
-
-        sleep(T)
-
-
-def nm_config_check():
-    # %% check that NetworkManager CLI is available and WiFi is active
-    ret = subprocess.check_output([NMCLI, '-t', 'radio', 'wifi'], universal_newlines=True, timeout=1.).strip().split(':')
-
-    if 'enabled' not in ret and 'disabled' in ret:
-        raise OSError('must enable WiFi, perhaps via nmcli radio wifi on')
-
-
-def get_nmcli() -> Optional[Dict[str, Any]]:
-
-    ret = subprocess.check_output(NMCMD, universal_newlines=True, timeout=1.)
-    sleep(0.5)  # nmcli errored for less than about 0.2 sec.
-    try:
-        subprocess.check_call(NMSCAN, timeout=1.)  # takes several seconds to update, so do it now.
-    except subprocess.CalledProcessError as e:
-        logging.error(f'consider slowing scan cadence.  {e}')
-
-    dat = pandas.read_csv(StringIO(ret), sep=r'(?<!\\):', index_col=False,
-                          header=0, encoding='utf8', engine='python',
-                          dtype=str, usecols=[0, 1, 3],
-                          names=['ssid', 'macAddress', 'signalStrength'])
-# %% optout
-    dat = dat[~dat['ssid'].str.endswith('_nomap')]
-# %% cleanup
-    dat['ssid'] = dat['ssid'].str.replace('nan', '')
-    dat['macAddress'] = dat['macAddress'].str.replace(r'\\:', ':')
-# %% JSON
-    jdat = dat.to_json(orient='records')
-    jdat = '{ "wifiAccessPoints":' + jdat + '}'
-#    print(jdat)
-# %% cloud MLS
-    try:
-        req = requests.post(URL, data=jdat)
-        if req.status_code != 200:
-            logging.error(req.text)
-            return None
-    except requests.exceptions.ConnectionError as e:
-        logging.error(f'no network connection.  {e}')
-        return None
-# %% process MLS response
-    jres = req.json()
-    loc = jres['location']
-    loc['accuracy'] = jres['accuracy']
-    loc['N'] = dat.shape[0]  # number of BSSIDs used
-    loc['t'] = datetime.now()
-
-    return loc
-# %%
-
-
-def csv2kml(csvfn: Path, kmlfn: Path):
-    from simplekml import Kml
-
-    """
-    write KML track/positions
-
-    t: vector of times
-    lonLatAlt: longitude, latitude, altitude or just lon,lat
-    ofn: KML filename to create
-    """
-
-    # lon, lat
-    dat = pandas.read_csv(csvfn, sep=' ', index_col=0, header=0)
-
-    t = dat.index.tolist()
-    lla = dat.loc[:, ['lon', 'lat']].values
-# %% write KML
-    """
-    http://simplekml.readthedocs.io/en/latest/geometries.html#gxtrack
-    https://simplekml.readthedocs.io/en/latest/kml.html#id1
-    https://simplekml.readthedocs.io/en/latest/geometries.html#simplekml.GxTrack
-    """
-    kml = Kml(name='My Kml')
-    trk = kml.newgxtrack(name='My Track')
-    trk.newwhen(t)  # list of times. MUST be format 2010-05-28T02:02:09Z
-    trk.newgxcoord(lla.tolist())  # list of lon,lat,alt, NOT ndarray!
-
-# just a bunch of points
-#        for i,p in enumerate(lla): # iterate over rows
-#            kml.newpoint(name=str(i), coords=[p])
-
-    print('writing', kmlfn)
-    kml.save(kmlfn)
+from .base import log_wifi_loc

mozloc/base.py

@@ -0,0 +1,34 @@
+from time import sleep
+from pathlib import Path
+
+from .netman import nm_config_check, get_nmcli
+
+HEADER = "time lat lon accuracy NumBSSIDs"
+
+
+def log_wifi_loc(T: float, logfile: Path):
+
+    if logfile:
+        logfile = Path(logfile).expanduser()
+        with logfile.open("a") as f:
+            f.write(HEADER + "\n")
+
+    print(f"updating every {T} seconds")
+    print(HEADER)
+
+    nm_config_check()
+    sleep(0.5)  # nmcli errored for less than about 0.2 sec.
+    while True:
+        loc = get_nmcli()
+        if loc is None:
+            sleep(T)
+            continue
+
+        stat = f'{loc["t"].isoformat(timespec="seconds")} {loc["lat"]} {loc["lng"]} {loc["accuracy"]:.1f} {loc["N"]:02d}'
+        print(stat)
+
+        if logfile:
+            with logfile.open("a") as f:
+                f.write(stat + "\n")
+
+        sleep(T)

mozloc/netman.py

@@ -0,0 +1,77 @@
+""" Network Manager CLI (nmcli) functions """
+import subprocess
+import typing
+import logging
+import shutil
+import pandas
+from io import StringIO
+from time import sleep
+import requests
+from datetime import datetime
+
+NMCLI = shutil.which("nmcli")
+if not NMCLI:
+    raise ImportError('This program relies on NetworkManager via "nmcli"')
+
+URL = "https://location.services.mozilla.com/v1/geolocate?key=test"
+NMCMD = [NMCLI, "-g", "SSID,BSSID,FREQ,SIGNAL", "device", "wifi"]  # Debian stretch, Ubuntu 18.04
+NMLEG = [NMCLI, "-t", "-f", "SSID,BSSID,FREQ,SIGNAL", "device", "wifi"]  # ubuntu 16.04
+NMSCAN = [NMCLI, "device", "wifi", "rescan"]
+
+
+def nm_config_check():
+    # %% check that NetworkManager CLI is available and WiFi is active
+    ret = subprocess.check_output([NMCLI, "-t", "radio", "wifi"], universal_newlines=True, timeout=1.0).strip().split(":")
+
+    if "enabled" not in ret and "disabled" in ret:
+        raise ConnectionError("must enable WiFi, perhaps via nmcli radio wifi on")
+
+
+def get_nmcli() -> typing.Dict[str, typing.Any]:
+
+    ret = subprocess.run(NMCMD, timeout=1.0)
+    if ret.returncode != 0:
+        raise ConnectionError(f"could not connect with NetworkManager for WiFi")
+    sleep(0.5)  # nmcli errored for less than about 0.2 sec.
+    # takes several seconds to update, so do it now.
+    ret = subprocess.run(NMSCAN, timeout=1.0, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True)
+    if ret.returncode != 0:
+        logging.error(f"consider slowing scan cadence.  {ret.stderr}")
+
+    dat = pandas.read_csv(
+        StringIO(ret.stdout),
+        sep=r"(?<!\\):",
+        index_col=False,
+        header=0,
+        encoding="utf8",
+        engine="python",
+        dtype=str,
+        usecols=[0, 1, 3],
+        names=["ssid", "macAddress", "signalStrength"],
+    )
+    # %% optout
+    dat = dat[~dat["ssid"].str.endswith("_nomap")]
+    # %% cleanup
+    dat["ssid"] = dat["ssid"].str.replace("nan", "")
+    dat["macAddress"] = dat["macAddress"].str.replace(r"\\:", ":")
+    # %% JSON
+    jdat = dat.to_json(orient="records")
+    jdat = '{ "wifiAccessPoints":' + jdat + "}"
+    logging.debug(jdat)
+    # %% cloud MLS
+    try:
+        req = requests.post(URL, data=jdat)
+        if req.status_code != 200:
+            logging.error(req.text)
+            return None
+    except requests.exceptions.ConnectionError as e:
+        logging.error(f"no network connection.  {e}")
+        return None
+    # %% process MLS response
+    jres = req.json()
+    loc = jres["location"]
+    loc["accuracy"] = jres["accuracy"]
+    loc["N"] = dat.shape[0]  # number of BSSIDs used
+    loc["t"] = datetime.now()
+
+    return loc