Name: sbProgram
Owner: UIdaho Library Digital
Description: A python program integrating with the Science Base REST API to count data, perform searches, etc.
Created: 2017-06-05 18:25:15.0
Updated: 2017-06-06 22:30:37.0
Pushed: 2018-03-01 22:32:54.0
Homepage: null
Size: 63572
Language: Python
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This is a program and web app meant to work with the SciencBase.gov REST API to generate reports useful for USGS CSC Data Managers. The program can count data on Science Base, determine DMP status, present Data Steward-PI history, and more. The current iteration of the project can parse through entire fiscal years or selected projects in the Northwest and Southwest Climate Science Center directories on ScienceBase.gov, and generate a report based on the selection provided. Data from Science Base is combined with data found in the combined Data Manager Google Sheets spreadsheet.
Entire commit history and contributor history can be found here: https://github.com/uidaholib/sbProgram
Python 3.6 is required to run this program. The program is currently best used on a recent version of Google Chrome.
Libraries you need to install to run sbMACRO Web App:
The recommended way to make sure you have all dependencies/prerequisites is to download the requirements.txt file and run
python -m pip install -r requirements.txt in the TrialWebApp directory.
Alternatively, to install each library manually, simply type python -m pip install <library_name> without the brackets.
Some necessary libraries come pre-installed with python and may not have been included in the prerequisites list above. They can be found in the requirements.txt file.
NOTE: pysb may need to be installed manually. To install pysb manually, follow instructions here: https://my.usgs.gov/bitbucket/projects/SBE/repos/pysb/browse
If the Google Sheets API python module doesn't install, try: python -m pip install --upgrade google-api-python-client
The project is also mid-development, so if you have trouble, or requirements.txt is not up to date, create an issue on our GitHub page or contact us.
Simply install all libraries and python 3 before running the program in your favorite command line/terminal program.
Creating a virtual environment is highly recommended so you do not affect your global version of python by installing all of these libraries. Information on virtualenv can be found here: https://virtualenv.pypa.io/en/stable/ . It is easy and highly recommended.
The simplest way to deploy the program is to clone the TrialWebApp directory to your local machine, open your favorite command line/terminal program, cd into the directory into which you cloned TrialWebApp,and install the prerequisites/dependencies as shown above.
Once you have the program installed (and your virtual environment is activated if applicable), run app.py
on app.py
The program should be up and running!
Go to your favorite browser (while in development, sbMACRO works best on Google Chrome) and type in
://localhost:5000/
You can then interact with the sbMACRO Web Application.
ScienceBase API, Python, Flask, Javascript
The MIT License
Copyright (c) 2017-2018 US Geological Survey https://www.usgs.gov/
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.