Added a README file
This commit is contained in:
32
README.md
Normal file
32
README.md
Normal file
@@ -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="<yourSQLusername>"
|
||||
export HP_SQL_PASSWORD="<yourSQLpassword>"
|
||||
export HP_SQL_SERVER="<yourSQLserverAddress>"
|
||||
export MESHIFY_USERNAME="<yourMeshifyUsername>"
|
||||
export MESHIFY_PASSWORD="<yourMeshifyPassword>"
|
||||
```
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user