percurnicus/opportunity

Local web application to view images from Opportunity Rover

opportunity's Issues

Perform a Database migration using alembic

Figure out a way to do a database migration with alembic to serve as an example

Finish Testing Database Backend

I got started with testing the database backend but still need to finish

Add documentation

Document the app with sphinx. See about adding a Swagger Server for the API. Might be worth documenting the web app as well

Expose posgres port to 5433 in tests

Configure the test container to expose 5432:5433 like the actual app does. See https://docker-py.readthedocs.io/en/1.8.0/port-bindings/

Test the web app functions

The web app functions that interact with the REST API need to be tested. Use mock to test the api

Turn website into an async project

Use python's asyncio to do tasks for the website asynchronously.

Also need to test the functions. See pytest-asyncio, also here

Test and Style AngularJS code

I should learn how to test angular code/javascript code in general. I should also learn the style guide for javascript/AngularJS

Fix bootstrap Vulnerability issue

Remediation

Upgrade bootstrap to version 3.4.1 or later. For example:

"dependencies": {
"bootstrap": ">=3.4.1"
}

or…

"devDependencies": {
"bootstrap": ">=3.4.1"
}

Security Features

Add security features to the web and database apps

1. Store Passwords in a User Database

   • https://www.youtube.com/watch?v=8ZtInClXe1Q
   • https://nakedsecurity.sophos.com/2013/11/04/anatomy-of-a-password-disaster-adobes-giant-sized-cryptographic-blunder/
   • https://nakedsecurity.sophos.com/2013/11/20/serious-security-how-to-store-your-users-passwords-safely/

2. AND/OR:

   • Use google to sign people in: https://cloud.google.com/python/getting-started/authenticate-users
     • May do both and have a different branch for this.

3. Add SSO to web app

   • https://flask-sso.readthedocs.io/en/latest/
   • https://developers.onelogin.com/saml/python

4. Add authentication to REST API

5. Stretch:

   • Add Two-Factor Authentication

Create production server

Description

Emulate a production server with Docker (new docker-compose.yml or just commented portions of the docker-compose.yml or with environments).

WSGI

For non asyncio branch:

• https://www.fullstackpython.com/wsgi-servers.html
• mod_wsgi
  • Docs
• Docker Apache
  • Example

ASGI

For asyncio branch:

• Talk
• Hypercorn

Add Continuous Integration

Create Continuous integration as an example of using docker for testing.

Separate website into multiple pages

• Home page: Look at images
• Product Page: Create/Edit product types
• Camera Page: Create/Edit camera names

Finish #2 first.

Use Sanic instead of Flask/Quart

Sanic is another asyncio web-framework. It would be worth creating a separate branch for to serve as an example.

Make rep citable

Add a DOI: https://guides.github.com/activities/citable-code/

Finish Initial front end

Create just the home page where a user can do the following:

• Create/choose product types
• Create/choose cameras
• Create entry of new image
• Select image (filtered by product type and camera) and display

Document webapp in README

Document how to start the docker containers, and what to expect when one opens the page

Add sentry for logging

See:

• http://flask.pocoo.org/docs/1.0/errorhandling/#error-logging-tools
• https://docs.sentry.io/clients/python/
• https://sentry.io/for/flask/
• https://docs.sentry.io/clients/javascript/integrations/angularjs/

Use websockets

Use websockets for the progress bar as an exercise.

Create a Cython Example

I've never used cython and should learn how to as it can be a great tool to have. The example can be quite simple such as calculating the average and std of an image. Maybe even try performing a rotation using matrix multiplication. I feel like the proper example that is not too hard that I can't do it in the little time I have but not too easy that I don't actually learn anything will be clearer when I try it.

Add versioning to database

Cool to show how versioning can be done to keep track of old data

Allows users to query the database query params

Right now, the api endpoints can only query by the id. Use the query params to query by more

Use pipenv

Use pipenv for python package management

Use type annotations and MyPy

Make use of pythons type annotations and use MyPy for static checking

Fix Security Issues

• Upgrade jquery to version 3.4.0 or later
• Upgrade SQLAlchemy to version 1.3.0 or later

Use Django and MySQL

In a different branch, use Django for the database interface and MySQL as the database manager

Create bower package.json

Create a package.json for js apps. Should eventually used by gulp

Use Redis for caching

Use a redish cache to store images already selected to improve the speed of displaying old images