src/ layout, functionalize for better testing and reuse

Author: scivision

.github/workflows/ci.yml

@@ -11,22 +11,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-python@v1
+    - uses: actions/setup-python@v2
       with:
         python-version: '3.x'
+
     - run: pip install .[tests,lint]
+
     - run: flake8
-    - run: mypy .
+    - run: mypy . src
+
     - run: pytest
-      working-directory: tests
+
 
   windows:
     runs-on: windows-latest
     steps:
     - uses: actions/checkout@v2
-    - uses: actions/setup-python@v1
+    - uses: actions/setup-python@v2
       with:
         python-version: '3.x'
+
     - run: pip install .[tests]
+
     - run: pytest
-      working-directory: tests

mypy.ini renamed to .mypy.ini

@@ -3,3 +3,6 @@ requires = ["setuptools", "wheel"]
 
 [tool.black]
 line-length = 132
+
+[tool.pytest.ini_options]
+addopts = "-ra -v"

csv2kml.py

@@ -1,6 +1,6 @@
 [metadata]
 name = mozloc
-version = 1.0.0
+version = 1.1.0
 author = Michael Hirsch, Ph.D.
 author_email = scivision@users.noreply.github.com
 url = https://github.com/scivision/mozilla-location-wifi
@@ -9,13 +9,12 @@ keywords =
   wifi
   geolocation
 classifiers =
-  Development Status :: 4 - Beta
+  Development Status :: 5 - Production/Stable
   Environment :: Console
   Intended Audience :: Information Technology
   Intended Audience :: System Administrators
   Operating System :: POSIX :: Linux
   Operating System :: Microsoft :: Windows
-  Programming Language :: Python :: 3.6
   Programming Language :: Python :: 3.7
   Programming Language :: Python :: 3.8
   Programming Language :: Python :: 3.9
@@ -27,14 +26,16 @@ long_description = file: README.md
 long_description_content_type = text/markdown
 
 [options]
-python_requires = >= 3.6
+python_requires = >= 3.7
 packages = find:
-scripts =
-  csv2kml.py
-  MozLoc.py
 install_requires =
   pandas
   requests
+package_dir=
+    =src
+
+[options.packages.find]
+where=src
 
 [options.extras_require]
 tests =
@@ -47,4 +48,5 @@ io =
 
 [options.entry_points]
 console_scripts =
-  MozLoc = MozLoc:main
+  MozLoc = mozloc.__main__:mozilla_location
+  mozloc_csv2kml = mozloc.__main__:csv2kml

mozloc/base.py

@@ -7,11 +7,11 @@
 
 Don't abuse the API or you'll get banned (excessive polling rate)
 """
-from mozloc import log_wifi_loc
+from .base import log_wifi_loc
 from argparse import ArgumentParser
 
 
-def main():
+def mozilla_location():
     """
     output: lat lon [deg] accuracy [m]
     """
@@ -20,10 +20,23 @@ def main():
     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(
+        "-url",
+        help="Mozilla location services URL--don't use this default test key",
+        default="https://location.services.mozilla.com/v1/geolocate?key=test",
+    )
     p = p.parse_args()
 
-    log_wifi_loc(p.cadence, p.logfile)
+    log_wifi_loc(p.cadence, p.url, p.logfile)
+
 
+def csv2kml():
+    """convert logged positions to KML"""
+    from .utils import csv2kml
+
+    p = ArgumentParser()
+    p.add_argument("logfn", help="csv logfile to read")
+    p.add_argument("kmlfn", help="kml filename to write")
+    p = p.parse_args()
 
-if __name__ == "__main__":
-    main()
+    csv2kml(p.logfn, p.kmlfn)