To get this application running using the flask local dev server you need to create a local_settings.py file under PubsWarehouse_UI folder. The contents of the file should looks like so:
SECRET_KEY = 'the_secret_key'
DEBUG = True #you want debug to be true for development, but not production
ASSETS_DEBUG = True #Set to False if you want to compress assets.
# URL for getting publication information
PUB_URL = "[server of choice]/pubs-services/"
# URL for getting lookup information- authors, contributing offices, etc
LOOKUP_URL = "[server of choice]/pubs-services/lookup/"
# URL for endpoint to get supersede info
SUPERSEDES_URL = "[server of choice]/service/citation/json/extras?"
# URL for Browse
BROWSE_URL = "[server of choice]/browse/"
# URL for Search
BASE_SEARCH_URL = "[server of choice]/pubs-services/publication"
# URL to instert into JSON-LD output- use the local address for local development
JSON_LD_ID_BASE_URL = 'http://127.0.0.1:5050/'
# replacement of relative links in the browse interface
BROWSE_REPLACE = "browse"
# Code for Google analytics- insert appropriate code for dev or prod. Can be left blank for local development
GOOGLE_ANALYTICS_CODE = 'GA-CODE-STRING'
# Code for webmaster tools- needed on prod only
GOOGLE_WEBMASTER_TOOLS_CODE = 'googlerandomstring'
# set variable for if robots are welcome to index the site or not
ROBOTS_WELCOME = False
# If logging is turned on or not
LOGGING_ON = False
# A string to put into the announcements block on the homepage- can contain html
ANNOUNCEMENT_BLOCK = ""
# The endpoint to get an authorization token based on AD credentials
AUTH_ENDPOINT_URL = '[server of choice]/pubs-services/auth/'
# The endpoint to get a preview of a pub that is only in mypubs
PREVIEW_ENDPOINT_URL = '[server of choice]/pubs-services/mppublications/'
# set the default path for the login page- for local development, it is '/login/'
LOGIN_PAGE_PATH = '/login/'
# verify ssl certificate for outside service calls
VERIFY_CERT = True or False #Set to False for local development
#cache settings- see the documentation for flask-cache. For development, a cache type of simple works well with the development server. redis is used on production
#CACHE_CONFIG = {'CACHE_TYPE': 'simple'}To create the virtualenv you should have python 2.7, virtualenv, pip installed. To install the javascript dependencies you will
need bower which can be installed by using npm install -g bower.
If you are on a linux environment, you can use run the dev_install.sh script. You should run this every time you pull down code but particularly if requirements.txt or pubs_ui/bower.json have been updated. Otherwise these are the steps you need to take.
-
Create a virtualenv using python 2.7.9 and install the requirements in 'requirements.txt'. This can be done as follows while in the project directory:
-
Run
virtualenv --python=python2.7 env -
Activate your virtualenv (depends on whether linux or windows)
-
Run
pip install -r requirements.txt -
Install the javascript dependencies. This requires bower. Do the following:
-
Change directory to pubs_ui
-
Run
bower install
You can start the app by running runserver.py, which will give you an output like so:
* Running on http://127.0.0.1:5050/
* Restarting with reloaderIf you want to generate a real secret key, you can do so trivially from the Python console by using os.urandom() like so:
>>> import os
>>> os.urandom(24)
'\xa1\x89D\x9e+\xb4Pl\xbfr\xa5\xc3\xc1\x05\x9c\x90\x91\x10\xa8\xfa\x10\xe7r\x9e'You can paste the generated string right into your SECRET_KEY global constant