diff --git a/README.md b/README.md new file mode 100644 index 0000000..4a159f8 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# POCloud-Scraper +Scrape production data from POCloud to push to accounting servers + +# Setup +System variables must be set up for the script to run. +``` +export HP_SQL_USER="" +export HP_SQL_PASSWORD="" +export HP_SQL_SERVER="" +export MESHIFY_USERNAME="" +export MESHIFY_PASSWORD="" +``` + +# Usage +It is useful to run the script and store the output in a log file. + +## Test Mode +The script has a test mode which will only retrieve the data. Test mode will not write date to the database. + +To run the script in test mode: +``` +python3 henryPetroleumMeshifyAPI.pt True >> output.log +``` + +## Normal Mode +In normal mode, the data will be grabbed from the Meshify API and inserted into the Production database. + +To run the script: +``` +python3 henryPetroleumMeshifyAPI.pt >> output.log +``` +