Merge pull request #21 from LCOGT/feature/update-readme

Feature/update readme

Author: timbeccue

.travis.yml

@@ -43,6 +43,33 @@ is used to denote commands that should be run using your virtual environment.
 
 The quickanalysis server should now be accessible from <http://127.0.0.1:5000>!
 
+## Deployment
+
+Deploy the application using the elastic beanstalk cli.
+This should already be installed in your virtual environment (see Local Development above).
+Additionally, ensure that you have aws credentials configured on your machine.
+
+### Initialize the CLI
+
+If this is a new environment, initialize elastic beanstalk with `$ eb init`.
+
+Select the region `us-east-1`, select the `quickanalysis` application, select `no` for CodeCommit.
+
+We currently use a single dev environment for this application. With `$ eb list`, verify that `quickanalysis-dev` is selected.
+
+### Deploy
+
+With cli initialized and configured, we can deploy by running `$ eb deploy`.
+
+For more information on using the eb cli, please refer to the [aws documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/eb-cli3.html).
+
+## Monitoring and Debugging
+
+Monitoring and debugging are both possible through the elastic beanstalk console.
+You can navigate to the console on your own, or with the eb cli by running `$ eb console`.
+
+Logs can also be retrieved directly in your terminal with `$ eb logs`.
+
 ## API Endpoints
 
 This server is accessible at http://quickanalysis.photonranch.org/.

README.md

@@ -1,86 +1,56 @@
-argon2-cffi==20.1.0
 astropy==4.2
-async-generator==1.10
 attrs==20.3.0
 auto-stretch==0.0.1
-awsebcli==3.19.3
-backcall==0.2.0
+awsebcli==3.20.3
 bcrypt==3.2.0
-bleach==3.3.0
 blessed==1.17.12
 boto3==1.16.33
-botocore==1.19.33
+botocore==1.23.54
 cached-property==1.5.2
-cachetools==4.2.1
+cachetools==5.2.0
 cement==2.8.2
 certifi==2020.12.5
 cffi==1.14.4
 chardet==3.0.4
+charset-normalizer==2.0.12
 click==7.1.2
 colorama==0.4.3
 coverage==5.3
 coveralls==2.2.0
 cryptography==3.2.1
 cycler==0.10.0
 decorator==4.4.2
-defusedxml==0.6.0
 docker==4.4.0
 docker-compose==1.25.5
 dockerpty==0.4.1
 docopt==0.6.2
-entrypoints==0.3
 flasgger==0.9.5
 Flask==1.1.2
 Flask-Cors==3.0.10
 future==0.16.0
-future-fstrings==1.2.0
 idna==2.10
 imageio==2.9.0
+importlib-metadata==4.0.1
 iniconfig==1.1.1
-ipykernel==5.4.3
-ipython==7.20.0
-ipython-genutils==0.2.0
-ipywidgets==7.6.3
 itsdangerous==1.1.0
-jedi==0.18.0
 Jinja2==2.11.2
 jmespath==0.10.0
 jsonschema==3.2.0
-jupyter==1.0.0
-jupyter-client==6.1.11
-jupyter-console==6.2.0
-jupyter-core==4.7.1
-jupyterlab-pygments==0.1.2
-jupyterlab-widgets==1.0.0
 kiwisolver==1.3.1
 MarkupSafe==1.1.1
 marshmallow==3.9.1
 matplotlib==3.3.3
-mistune==0.8.4
-monotonic==1.5
-nbclient==0.5.1
-nbconvert==6.0.7
-nbformat==5.1.2
-nest-asyncio==1.5.1
+mistune==2.0.3
 networkx==2.5
-notebook==6.2.0
 numpy==1.19.4
 packaging==20.7
-pandocfilters==1.4.3
 paramiko==2.7.2
-parso==0.8.1
-pathspec==0.5.9
-pexpect==4.8.0
-pickleshare==0.7.5
+pathspec==0.9.0
 Pillow==8.0.1
 pluggy==0.13.1
-prometheus-client==0.9.0
-prompt-toolkit==3.0.14
-ptyprocess==0.7.0
 py==1.9.0
 pycparser==2.20
 pyerfa==1.7.1.1
-Pygments==2.7.4
 PyNaCl==1.4.0
 pyparsing==2.4.7
 pyrsistent==0.17.3
@@ -90,27 +60,19 @@ python-dateutil==2.8.1
 python-dotenv==0.15.0
 PyWavelets==1.1.1
 PyYAML==5.3.1
-pyzmq==22.0.2
-qtconsole==5.0.2
-QtPy==1.9.0
-requests==2.24.0
+requests==2.26.0
 s3transfer==0.3.3
 scikit-image==0.17.2
 scipy==1.5.4
-semantic-version==2.5.0
-Send2Trash==1.5.0
-six==1.15.0
+semantic-version==2.8.5
+six==1.14.0
 termcolor==1.1.0
-terminado==0.9.2
-testpath==0.4.4
 texttable==1.6.3
 tifffile==2020.12.8
 toml==0.10.2
-tornado==6.1
-traitlets==5.0.5
-urllib3==1.25.11
+typing-extensions==3.7.4.3
+urllib3==1.26.9
 wcwidth==0.1.9
-webencodings==0.5.1
 websocket-client==0.57.0
 Werkzeug==1.0.1
-widgetsnbextension==3.5.1
+zipp==3.4.1