Merge pull request #1 from signals-dev/apidoc

Apidoc

Author: dyuliu

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,16 @@
+-   MTV version:
+-   Python version:
+-   Node version:
+-   Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

.github/workflows/server.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Server CI
+
+on:
+  push:
+    branches: [master, master-dev]
+  pull_request:
+    branches: [master, master-dev]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: [3.6]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Package
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev]
+      - name: Lint with flake8
+        run: |
+          make lint
+      - name: Test with py.test (Flask)
+        run: |
+          make test-server

.gitignore

@@ -4,7 +4,8 @@ tempCodeRunnerFile.ts
 tempCodeRunnerFile.py
 mtv.tar*
 .vscode/
-
+orion-stock/
+stock-data/
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

client/.prettierrc.js .prettierrc.jsclient/.prettierrc.js renamed to .prettierrc.js

@@ -3,19 +3,12 @@ module.exports = {
   trailingComma: 'all',
   singleQuote: true,
   printWidth: 120,
-  tabWidth: 2,
+  tabWidth: 4,
   overrides: [
     {
-      files: ['*.scss', '*.css'],
-      options: {
-        tabWidth: 4,
-      },
-    },
-    {
-      files: '*.html',
+      files: ['*.yml'],
       options: {
         tabWidth: 2,
-        singleQuote: false,
       },
     },
   ],

.travis.yml

@@ -17,7 +17,7 @@ services:
   - mongodb
 
 # Command to install dependencies
-install: 
+install:
   - pip install -U tox-travis
   - nvm install ${NODE}
   - node --version
@@ -28,7 +28,7 @@ before_script:
   - cd client && npm install
 
 # Command to run tests
-script: 
+script:
   - cd $TRAVIS_BUILD_DIR
   - tox # test back-end
   - npm -C client run test:karma # test front-end
@@ -37,7 +37,6 @@ after_script:
   - npm -C client run test:karma:coverage # test front-end coverage
   - npm install -g lcov-result-merger@~1.2.0
   - lcov-result-merger 'client/coverage/**/lcov.info' | client/node_modules/coveralls/bin/coveralls.js
-
 # deploy:
 #   # Automatically build and deploy documentation to GitHub Pages
 #   - provider: pages

.vscode/launch.json

@@ -34,35 +34,47 @@ help:
 # ----------------------- session: install ----------------------- #
 
 .PHONY: install
-install: clean-build clean-pyc clean-client ## install the packages for running mtv
-	pip install -e .
-	$(MAKE) init-db && 	$(MAKE) load-db-mtv
-	cd client && npm install --production && npm run build
+install: clean-build clean-pyc  ## install the packages for running mtv
+	pip install .
+	$(MAKE) init-db && $(MAKE) load-db
+
+.PHONY: install-test
+install-test: clean-build clean-pyc ## install the package and test dependencies
+	pip install .[test]
+	$(MAKE) init-db && $(MAKE) load-db-test
 
 .PHONY: install-develop
-install-develop: clean-build clean-pyc clean-client ## install the package in editable mode and dependencies for development
+install-develop: clean-build clean-pyc  ## install the package in editable mode and dependencies for development
 	pip install -e .[dev]
-	$(MAKE) init-db && 	$(MAKE) load-db-mtv
-	cd client && npm install && npm run build
+	$(MAKE) init-db && $(MAKE) load-db && $(MAKE) load-db-test
 
 .PHONY: init-db
 init-db: clean-db
 	mkdir -p db-instance
+	# this folder is for saving the downloaded demo mongodb data
 	mkdir -p db-instance/data
+	# this folder is for saving the log files
 	mkdir -p db-instance/log
+	# this folder is for saving the newly dumped mongodb data
 	mkdir -p db-instance/dump
 
-.PHONY: load-db-mtv
-load-db-mtv: init-db
-	rm -f -r db-instance/data/mtv/
+.PHONY: load-db
+load-db: init-db
 	curl -o mtv.tar.bz2 "https://d3-ai-mtv.s3.us-east-2.amazonaws.com/mtv.tar.bz2"
 	tar -xf mtv.tar.bz2 -C ./db-instance/data/ && rm mtv.tar.bz2
 	mongo mtv --eval "db.dropDatabase()"
 	mongorestore --db mtv ./db-instance/data/mtv/
 
+.PHONY: load-db-test
+load-db-test: init-db
+	curl -o mtv-test.tar.bz2 "https://d3-ai-mtv.s3.us-east-2.amazonaws.com/mtv-test.tar.bz2"
+	tar -xf mtv-test.tar.bz2 -C ./db-instance/data/ && rm mtv-test.tar.bz2
+	mongo mtv-test --eval "db.dropDatabase()"
+	mongorestore --db mtv-test ./db-instance/data/mtv-test/
+
 # ------------------ session: docker installation ------------------- #
 .PHONY: docker-db-up
-docker-db-up: init-db			## download data and load them into mongodb  
+docker-db-up: init-db	## download data and load them into mongodb  
 	curl -o mtv.tar.bz2 "https://d3-ai-mtv.s3.us-east-2.amazonaws.com/mtv.tar.bz2"
 	tar -xf mtv.tar.bz2 -C ./db-instance/data/ && rm mtv.tar.bz2
 	docker-compose -f docker-compose-db.yml up
@@ -84,7 +96,7 @@ docker-down: 			## remove containers, volumes, and networks
 	docker-compose down -v
 
 .PHONY: docker-clean
-docker-clean: 		## remove containers, volumes, networks, and images
+docker-clean: 			## remove containers, volumes, networks, and images
 	docker-compose down -v --rmi all
 
 # ----------------------- session: test ----------------------- #
@@ -100,10 +112,6 @@ test-server: ## run tests on server
 test-server-flask: ## run tests on server
 	py.test ./tests/test_flask.py
 
-.PHONY: test-client
-test-client: ## run tests on client
-	npm -C client run test:karma
-
 .PHONY: test-coverage
 test-coverage: ## check code coverage quickly with the default Python
 	coverage run --source mtv -m pytest
@@ -148,9 +156,13 @@ view-docs: docs ## view docs in browser
 serve-docs: view-docs ## compile the docs watching for changes
 	watchmedo shell-command -W -R -D -p '*.rst;*.md' -c '$(MAKE) -C docs html' .
 
-.PHONY: api-docs
-api-docs:	## generate server API docs
-	apidoc -i mtv\\resources\\ -o apidoc\\
+.PHONY: apidoc
+apidoc:	## generate server API docs
+	apidoc -i mtv/resources -o apidoc/
+
+.PHONY: view-apidoc
+view-apidoc:	## view server API docs
+	$(BROWSER) apidoc/index.html
 
 # -------------------- session: release ---------------------- #