reformat repo

Quansight · Oct 29, 2020 · 3ef87f0 · 3ef87f0
1 parent 6bcdc25
commit 3ef87f0
Show file tree

Hide file tree

Showing 21 changed files with 20 additions and 170 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,20 @@
-# Public Content
+# Mortgage Calculator
+This repo contains the code to run a mortgage calculator app using Panel.
+To see a running version of this app, please visit (binder url here eventually).
+
+## Install environment
+You need conda installed to run this app.  Create the `panel` environment by running the following:
+`conda env create -f environment.yml`
+
+## Deploy App Locally
+After having installed the environment, activate it with:
+- `conda activate panel`  
+
+Then start the app by running on the command line:
+- `python -m mortgage_calculator`  
+
+You can see the app by navigating to the url which will appear on the command line in a browser (IE 11 not supported).
+
+## Run tests
+To run the repo tests, run the following in the command line when in the repo root folder.  
+- `pytest`
diff --git a/...g-aids/panel-learning-aid/binder_nb.ipynb → binder_nb.ipynb b/...g-aids/panel-learning-aid/binder_nb.ipynb → binder_nb.ipynb
diff --git a/...g-aids/panel-learning-aid/environment.yml → environment.yml b/...g-aids/panel-learning-aid/environment.yml → environment.yml
diff --git a/learning-aids/panel-learning-aid/isort.cfg → isort.cfg b/learning-aids/panel-learning-aid/isort.cfg → isort.cfg
diff --git a/learning-aids/panel-learning-aid/.gitignore b/learning-aids/panel-learning-aid/.gitignore
diff --git a/learning-aids/panel-learning-aid/README.md b/learning-aids/panel-learning-aid/README.md
diff --git a/...ids/panel-learning-aid/learning_aid.ipynb → learning_aid.ipynb b/...ids/panel-learning-aid/learning_aid.ipynb → learning_aid.ipynb
diff --git a/...rning-aid/mortgage_calculator/__init__.py → mortgage_calculator/__init__.py b/...rning-aid/mortgage_calculator/__init__.py → mortgage_calculator/__init__.py
diff --git a/...rning-aid/mortgage_calculator/__main__.py → mortgage_calculator/__main__.py b/...rning-aid/mortgage_calculator/__main__.py → mortgage_calculator/__main__.py
diff --git a/...earning-aid/mortgage_calculator/config.py → mortgage_calculator/config.py b/...earning-aid/mortgage_calculator/config.py → mortgage_calculator/config.py
diff --git a/...earning-aid/mortgage_calculator/layout.py → mortgage_calculator/layout.py b/...earning-aid/mortgage_calculator/layout.py → mortgage_calculator/layout.py
diff --git a/...ing-aid/mortgage_calculator/my_logging.py → mortgage_calculator/my_logging.py b/...ing-aid/mortgage_calculator/my_logging.py → mortgage_calculator/my_logging.py
diff --git a/...learning-aid/mortgage_calculator/plots.py → mortgage_calculator/plots.py b/...learning-aid/mortgage_calculator/plots.py → mortgage_calculator/plots.py
diff --git a/...aid/mortgage_calculator/tests/__init__.py → mortgage_calculator/tests/__init__.py b/...aid/mortgage_calculator/tests/__init__.py → mortgage_calculator/tests/__init__.py
diff --git a/.../mortgage_calculator/tests/test_layout.py → mortgage_calculator/tests/test_layout.py b/.../mortgage_calculator/tests/test_layout.py → mortgage_calculator/tests/test_layout.py
diff --git a/...d/mortgage_calculator/tests/test_plots.py → mortgage_calculator/tests/test_plots.py b/...d/mortgage_calculator/tests/test_plots.py → mortgage_calculator/tests/test_plots.py
diff --git a/...d/mortgage_calculator/tests/test_utils.py → mortgage_calculator/tests/test_utils.py b/...d/mortgage_calculator/tests/test_utils.py → mortgage_calculator/tests/test_utils.py
diff --git a/...learning-aid/mortgage_calculator/utils.py → mortgage_calculator/utils.py b/...learning-aid/mortgage_calculator/utils.py → mortgage_calculator/utils.py
diff --git a/...arning-aid/mortgage_calculator/widgets.py → mortgage_calculator/widgets.py b/...arning-aid/mortgage_calculator/widgets.py → mortgage_calculator/widgets.py
diff --git a/learning-aids/panel-learning-aid/pytest.ini → pytest.ini b/learning-aids/panel-learning-aid/pytest.ini → pytest.ini
diff --git a/learning-aids/panel-learning-aid/setup.py → setup.py b/learning-aids/panel-learning-aid/setup.py → setup.py