Merge pull request #3 from MrClock8163/dna

DNA support with GSI Online

Author: MrClock8163

.github/workflows/run-tests.yml

@@ -2,6 +2,10 @@ name: Automated testing
 
 on: push
 
+env:
+  FORCE_COLOR: 1
+  MYPY_FORCE_COLOR: 1
+
 jobs:
   testing:
     name: Running tests
@@ -23,8 +27,8 @@ jobs:
 
       - name: Test with pytest
         run: |
-          python -m pip install pytest
-          python -m pytest
+          python -m pip install -r requirements.txt
+          python -m pytest -v --color=yes
   
   linting:
     name: Linting

docs/api/dna/index.rst

@@ -0,0 +1,16 @@
+geocompy.dna
+============
+
+.. module:: geocompy.dna
+
+.. autoclass:: DNA
+    :members:
+    :class-doc-from: both
+
+
+.. toctree::
+    :maxdepth: 1
+
+    meta
+    settings
+    measurements

docs/api/dna/measurements.rst

@@ -0,0 +1,9 @@
+geocompy.dna.measurements
+=========================
+
+.. module:: geocompy.dna.measurements
+
+.. autoclass:: DNAMeasurements
+    :members:
+    :undoc-members:
+    :class-doc-from: both

docs/api/dna/meta.rst

@@ -0,0 +1,10 @@
+geocompy.dna.meta
+=================
+
+.. module:: geocompy.dna.meta
+
+.. autodata:: param_descriptions
+    :no-value:
+
+.. autodata:: word_descriptions
+    :no-value:

docs/api/dna/settings.rst

@@ -0,0 +1,9 @@
+geocompy.dna.settings
+=====================
+
+.. module:: geocompy.dna.settings
+
+.. autoclass:: DNASettings
+    :members:
+    :undoc-members:
+    :class-doc-from: both

docs/conf.py

@@ -100,13 +100,15 @@
 
 # Immaterial toc adjustments
 object_description_options = [
-    ("py:.*", 
+    (
+        "py:.*",
         {
             "include_fields_in_toc": False,
             "include_rubrics_in_toc": False
         }
     ),
-    ("py:parameter",
+    (
+        "py:parameter",
         {
             "include_in_toc": False
         }
@@ -123,7 +125,9 @@
 napoleon_google_docstring = False
 napoleon_use_ivar = True
 napoleon_type_aliases = {
-    "GeoComResponse": "~geocompy.GeoComResponse"
+    "GeoComResponse": "~geocompy.GeoComResponse",
+    "GsiOnlineResponse": "~geocompy.GsiOnlineResponse",
+    "datetime": "~datetime.datetime"
 }
 
 python_display_short_literal_types = True
@@ -142,8 +146,8 @@
     ("py:obj", r"[a-zA-Z]{3}\.\w+")
 }
 
-# GitHub source linking
-def linkcode_resolve(domain, info):
+
+def linkcode_resolve(domain, info):  # GitHub source linking
     if domain != 'py':
         return None
     if not info['module']:
@@ -154,6 +158,7 @@ def linkcode_resolve(domain, info):
         f"geocompy/tree/main/src/{filename:s}.py"
     )
 
+
 latex_documents = [
     (
         "latexindex", "geocompy.tex",

docs/index.rst

@@ -38,6 +38,7 @@ Content
    api/communication
    api/tps1200p/index
    api/vivatps/index
+   api/dna/index
 
 Indices
 

docs/latexindex.rst

@@ -23,3 +23,4 @@ API documentation
    api/communication
    api/tps1200p/index
    api/vivatps/index
+   api/dna/index

docs/overview.rst

@@ -19,6 +19,8 @@ Features
     - GeoCom
         - TPS1200P
         - VivaTPS
+    - GSI Online
+        - DNA
 
 Requirements
 ------------

pyproject.toml

@@ -42,3 +42,4 @@ version-file = "src/geocompy/_version.py"
 [tool.pytest.ini_options]
 addopts = ["-ra"]
 testpaths = ["tests", "src", "examples"]
+required_plugins = "pytest-mock"