modernize, skip non-wifi ci

Author: scivision

.gitignore

@@ -1,3 +1,4 @@
+.mypy_cache/
 .pytest_cache/
 *.log
 *.txt

MozLoc.py

@@ -8,21 +8,21 @@
 Uses ``nmcli`` from Linux only. Could be extended to other tools and OS.
 """
 from mozloc import logwifiloc
+from argparse import ArgumentParser
 
 
-if __name__ == '__main__':
+def main():
     """
     output: lat lon [deg] accuracy [m]
     """
-    import signal
-    signal.signal(signal.SIGINT, signal.SIG_DFL)
-
-    from argparse import ArgumentParser
     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)
+
+
+if __name__ == '__main__':
+    main()

README.md

@@ -1,5 +1,4 @@
 [![Python versions (PyPI)](https://img.shields.io/pypi/pyversions/mozilla-location-python.svg)](https://pypi.python.org/pypi/mozilla-location-python)
-
 [![Distribution format (PyPI)](https://img.shields.io/pypi/format/mozilla-location-python.svg)](https://pypi.python.org/pypi/mozilla-location-python)
 
 # mozilla-location-python

csv2kml.py

@@ -1,13 +1,17 @@
 #!/usr/bin/env python
 """convert logged positions to KML"""
 from mozloc import csv2kml
+from argparse import ArgumentParser
 
-if __name__ == '__main__':
-    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__':
+    main()

mozloc/__init__.py

@@ -6,27 +6,29 @@
 from datetime import datetime
 from time import sleep
 from pathlib import Path
+from typing import Dict, Any, Optional
 #
-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'
+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):
+
+
+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.
+    sleep(0.5)  # nmcli errored for less than about 0.2 sec.
     while True:
         loc = get_nmcli()
         if loc is None:
@@ -42,34 +44,37 @@ def logwifiloc(T:float, logfile:Path):
 
         sleep(T)
 
+
 def nm_config_check():
-# %% check that NetworkManager CLI is available and WiFi is active
+    # %% check that NetworkManager CLI is available and WiFi is active
     try:
-        ret = subprocess.check_output(['nmcli','-t','radio','wifi'], universal_newlines=True, timeout=1.).strip().split(':')
+        ret = subprocess.check_output(['nmcli', '-t', 'radio', 'wifi'], universal_newlines=True, timeout=1.).strip().split(':')
     except FileNotFoundError:
         raise OSError('CUrrently this program relies on NetworkManager')
 
-    assert 'enabled' in ret and not 'disabled' in ret,'must enable WiFi, perhaps via nmcli radio wifi on'
+    assert 'enabled' in ret and 'disabled' not in ret, 'must enable WiFi, perhaps via nmcli radio wifi on'
 
 # %%
-def get_nmcli() -> dict:
+
+
+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.
+    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.
+        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'])
+                          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'\\:',':')
+    dat['ssid'] = dat['ssid'].str.replace('nan', '')
+    dat['macAddress'] = dat['macAddress'].str.replace(r'\\:', ':')
 # %% JSON
     jdat = dat.to_json(orient='records')
     jdat = '{ "wifiAccessPoints":' + jdat + '}'
@@ -79,21 +84,22 @@ def get_nmcli() -> dict:
         req = requests.post(URL, data=jdat)
         if req.status_code != 200:
             logging.error(req.text)
-            return
+            return None
     except requests.exceptions.ConnectionError as e:
         logging.error(f'no network connection.  {e}')
-        return
+        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['N'] = dat.shape[0]  # number of BSSIDs used
     loc['t'] = datetime.now()
 
     return loc
 # %%
 
-def csv2kml(csvfn:Path, kmlfn:Path):
+
+def csv2kml(csvfn: Path, kmlfn: Path):
     from simplekml import Kml
 
     """
@@ -108,7 +114,7 @@ def csv2kml(csvfn:Path, kmlfn:Path):
     dat = pandas.read_csv(csvfn, sep=' ', index_col=0, header=0)
 
     t = dat.index.tolist()
-    lla = dat.loc[:,['lon','lat']].values
+    lla = dat.loc[:, ['lon', 'lat']].values
 # %% write KML
     """
     http://simplekml.readthedocs.io/en/latest/geometries.html#gxtrack
@@ -118,7 +124,7 @@ def csv2kml(csvfn:Path, kmlfn:Path):
     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!
+    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

setup.cfg

@@ -0,0 +1,76 @@
+[metadata]
+name = mozilla-location-python
+version = 0.5.1
+author = Michael Hirsch, Ph.D.
+url = https://github.com/scivision/mozilla-location-wifi-python
+description = Using Mozilla Location services, log location vs. time using WiFi or convert to KML.
+keywords = 
+  wifi
+  geolocation
+classifiers =
+  Development Status :: 4 - Beta
+  Environment :: Console
+  Intended Audience :: Information Technology
+  Intended Audience :: System Administrators
+  License :: OSI Approved :: MIT License
+  Operating System :: OS Independent
+  Programming Language :: Python :: 3.6
+  Programming Language :: Python :: 3.7
+  Topic :: System :: Networking
+  Topic :: Utilities
+license_file = LICENSE
+long_description = file: README.md
+long_description_content_type = text/markdown
+
+[options]
+python_requires = >= 3.6
+setup_requires = 
+  setuptools >= 38.6
+  pip >= 10
+  twine >= 1.11
+include_package_data = True
+packages = find:
+install_requires =
+  pandas
+  requests
+
+[options.extras_require]
+tests = 
+  pytest
+  pytest-cov
+  coveralls
+  flake8
+  mypy
+kml = 
+  simplekml
+
+[options.entry_points]
+console_scripts =
+  MozLoc = MozLoc:main
+  csv2kml = csv2kml:main
+
+
+[flake8]
+max-line-length = 132
+exclude = .git,__pycache__,.eggs/,doc/,docs/,build/,dist/,archive/
+
+[coverage:run]
+cover_pylib = false
+omit =
+  /home/travis/virtualenv/*
+  */site-packages/*
+  */bin/*
+
+[coverage:report]
+exclude_lines =
+  pragma: no cover
+  def __repr__
+  RuntimeError
+  NotImplementedError
+  ImportError
+  KeyError
+  FileNotFoundError
+  CalledProcessError
+  logging.warning
+  ValueError
+  TypeError

setup.py

@@ -1,33 +1,3 @@
 #!/usr/bin/env python
-install_requires = ['pandas','requests']
-tests_require = ['nose','coveralls']
-# %%
-from setuptools import setup,find_packages
-
-setup(name='mozilla-location-python',
-      packages=find_packages(),
-      author='Michael Hirsch, Ph.D.',
-      version='0.5.1',
-      url='https://github.com/scivision/mozilla-location-wifi-python',
-      long_description=open('README.md').read(),
-      long_description_content_type="text/markdown",
-      description='Using Mozilla Location services, log location vs. time using WiFi or convert to KML.',
-      install_requires=install_requires,
-      tests_require=tests_require,
-      extras_require={'tests':tests_require,
-                      'kml':['simplekml']},
-      python_requires='>=3.6',
-      classifiers=[
-      'Development Status :: 4 - Beta',
-      'Environment :: Console',
-      'Intended Audience :: Information Technology',
-      'Intended Audience :: System Administrators',
-      'License :: OSI Approved :: MIT License',
-      'Operating System :: OS Independent',
-      'Programming Language :: Python :: 3.6',
-      'Programming Language :: Python :: 3.7',
-      'Topic :: System :: Networking',
-      'Topic :: Utilities',
-      ],
-	  )
-
+from setuptools import setup
+setup()

tests/test_all.py

@@ -1,45 +1,21 @@
 #!/usr/bin/env python
-from numpy.testing import run_module_suite
+import pytest
 import mozloc
 import datetime
+import os
+
+CI = bool(os.environ['CI']) if 'CI' in os.environ else False
+
 
 def test_nm_loc():
     loc = mozloc.get_nmcli()
-    assert isinstance(loc,dict)
-    assert isinstance(loc['t'],datetime.datetime)
+    assert isinstance(loc, dict)
+    assert isinstance(loc['t'], datetime.datetime)
 
+pytest.mark.skipif(CI, reason="CI doesn't have WiFi")
 def test_nm_connection():
     mozloc.nm_config_check()
 
 
-def gen_kml():
-    from simplekml import Kml
-    # Data for the track
-    when = ["2010-05-28T02:02:09Z",
-        "2010-05-28T02:02:35Z",
-        "2010-05-28T02:02:44Z",
-        "2010-05-28T02:02:53Z",
-        "2010-05-28T02:02:54Z",
-        "2010-05-28T02:02:55Z",
-        "2010-05-28T02:02:56Z"]
-
-    coord = [(-122.207881,37.371915,156.000000),
-        (-122.205712,37.373288,152.000000),
-        (-122.204678,37.373939,147.000000),
-        (-122.203572,37.374630,142.199997),
-        (-122.203451,37.374706,141.800003),
-        (-122.203329,37.374780,141.199997),
-        (-122.203207,37.374857,140.199997)]
-
-
-    kml = Kml(name="Tracks",)
-    trk = kml.newgxtrack(name='test')
-
-    trk.newwhen(when)
-    trk.newgxcoord(coord)
-
-    kml.save('Test.kml')
-
-
 if __name__ == '__main__':
-    run_module_suite()
+    pytest.main()

tests/test_kml.py

@@ -0,0 +1,33 @@
+import pytest
+from simplekml import Kml
+    
+
+def gen_kml():
+    # Data for the track
+    when = ["2010-05-28T02:02:09Z",
+            "2010-05-28T02:02:35Z",
+            "2010-05-28T02:02:44Z",
+            "2010-05-28T02:02:53Z",
+            "2010-05-28T02:02:54Z",
+            "2010-05-28T02:02:55Z",
+            "2010-05-28T02:02:56Z"]
+
+    coord = [(-122.207881, 37.371915, 156.000000),
+             (-122.205712, 37.373288, 152.000000),
+             (-122.204678, 37.373939, 147.000000),
+             (-122.203572, 37.374630, 142.199997),
+             (-122.203451, 37.374706, 141.800003),
+             (-122.203329, 37.374780, 141.199997),
+             (-122.203207, 37.374857, 140.199997)]
+
+    kml = Kml(name="Tracks",)
+    trk = kml.newgxtrack(name='test')
+
+    trk.newwhen(when)
+    trk.newgxcoord(coord)
+
+    kml.save('Test.kml')
+    
+
+if __name__ == '__main__':
+    pytest.main()