Merge pull request #75 from Stanford-NavLab/derwin/release-0.1.6

Derwin/release 0.1.6

Author: kanhereashwin

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**System Information (please complete the following information):**
+ - OS: [e.g. Ubuntu]
+ - OS Version: [e.g. 20.04]
+- Python Version: [e.g. 3.9.10]
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/pip-install.yml

@@ -1,10 +1,10 @@
-name: pip-install-test
+name: pip-install
 
 on:
   pull_request:
     branches: [ main ]
   workflow_dispatch:
-    
+
 
 jobs:
   build:
@@ -31,7 +31,7 @@ jobs:
 #     - name: Load cached poetry environment
 #       id: cached-poetry-dependencies
 #       uses: actions/cache@v2
-#       with: 
+#       with:
 #         path: .venv
 #         key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
 #     - name: Install dependencies

.github/workflows/pylint.yml

@@ -1,6 +1,6 @@
-name: lint
+name: pylint
 
-on: 
+on:
   pull_request:
     branches: [ main ]
   workflow_dispatch:
@@ -27,7 +27,7 @@ jobs:
     - name: Load cached poetry environment
       id: cached-poetry-dependencies
       uses: actions/cache@v2
-      with: 
+      with:
         path: .venv
         key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}
     - name: Install dependencies

.github/workflows/pypi-release.yml

@@ -0,0 +1,40 @@
+# workflow copied from combination of
+# 1) https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
+# 2) https://www.caktusgroup.com/blog/2021/02/11/automating-pypi-releases/
+
+name: pypi-release
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  deploy:
+    name: Build and publish Python distribution to PyPI
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/python-app.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: build
+name: python-app
 
 on:
   push:

README.md

@@ -84,7 +84,14 @@ In the directory organization above:
 
 Installation
 ------------
-For directions on how to install the `gnss_lib_py` project, please
+
+`gnss_lib_py` is available through `pip` installation with:
+
+```
+pip install gnss-lib-py
+```
+
+For directions on how to install an editable or developer installation of `gnss_lib_py` on Linux, MacOS, and Windows, please
 see the [install instructions](https://gnss-lib-py.readthedocs.io/en/latest/install.html).
 
 Tutorials

docs/source/index.rst

@@ -33,6 +33,12 @@ We provide standard row names for :code:`NavData` elements on the
 These names ensure cross compatability between different datasets and
 algorithms.
 
+Source Code
+-----------
+All source code is available on GitHub at
+`github.com/stanford-navlab/gnss_lib_py <https://github.com/stanford-navlab/gnss_lib_py>`__.
+
+
 .. _organization:
 
 Code Organization
@@ -87,7 +93,15 @@ In the directory organization above:
 
 Installation
 ------------
-For directions on how to install the :code:`gnss_lib_py` project, please
+
+``gnss_lib_py`` is available through ``pip`` installation with:
+
+.. code-block:: bash
+
+   pip install gnss-lib-py
+
+For directions on how to install an editable or developer installation
+of ``gnss_lib_py`` on Linux, MacOS, and Windows, please
 see the :ref:`install instructions<install>`.
 
 Tutorials

gnss_lib_py/utils/file_operations.py

@@ -37,3 +37,22 @@ def get_timestamp():
     """
     timestamp =  time.strftime("%Y%m%d%H%M%S")
     return timestamp
+
+def print_directory_levels():
+    """Prints out file directory levels.
+
+    """
+
+    printed_path = os.path.realpath(__file__)
+
+    for level in range(5):
+        print(f"{level} level(s) up: {printed_path}")
+        printed_path = os.path.dirname(printed_path)
+
+def print_cwd():
+    """Prints out file directory levels.
+
+    """
+
+    print("cwd:",os.getcwd())
+    print("dir above cwd:",os.path.dirname(os.getcwd()))

gnss_lib_py/utils/visualizations.py

@@ -670,11 +670,7 @@ def _save_figure(figures, titles=None, prefix="", fnames=None): # pragma: no cov
         if (len(fnames) == 1 and fnames[0] is None) \
             or fnames[fig_idx] is None:
             # create results folder if it does not yet exist.
-            root_path = os.path.dirname(
-                        os.path.dirname(
-                        os.path.dirname(
-                        os.path.realpath(__file__))))
-            log_path = os.path.join(root_path,"results",TIMESTAMP)
+            log_path = os.path.join(os.getcwd(),"results",TIMESTAMP)
             fo.make_dir(log_path)
 
             # make name path friendly
@@ -856,11 +852,7 @@ def _save_plotly(figures, titles=None, prefix="", fnames=None,
         if (len(fnames) == 1 and fnames[0] is None) \
             or fnames[fig_idx] is None:
             # create results folder if it does not yet exist.
-            root_path = os.path.dirname(
-                        os.path.dirname(
-                        os.path.dirname(
-                        os.path.realpath(__file__))))
-            log_path = os.path.join(root_path,"results",TIMESTAMP)
+            log_path = os.path.join(os.getcwd(),"results",TIMESTAMP)
             fo.make_dir(log_path)
 
             # make name path friendly

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+filterwarnings =
+    ignore:distutils:DeprecationWarning