diff --git a/LICENSE.md b/LICENSE.md new file mode 100755 index 0000000..9971445 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +### MIT License + +Copyright (c) 2020 Erbosoft Metaverse Design Solutions + +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. diff --git a/README.md b/README.md index 49ef2fa..ede5cb0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # distance-calc -Python-based distance calculator to help determine how far new apartment complexes are from the office. \ No newline at end of file +A Python-based distance calculator to help determine how far new apartment complexes are from the office. + +## Scripts + +* **gcoder.py** - Takes an address on the command line and returns its latitude and longitude. + May use one of four different geocoding engines. +* **dcalc.py** - Takes an address on the command line and returns its latitude and longitude, + distance from the VMware Carbon Black Boulder office, and projected drive time to the + Boulder office. Uses Google APIs. +* **batch_distance.py** - Same as dcalc, but uses CSV files for input and output. + +## Configuration File + +All scripts make use of a configuration file, called `geoapi.ini` by default, that contains the +API keys. Copy the file `geoapi.ini.template` and add your API keys. You can also specify a different +configuration file with the `-C` or `--config` option to each script. diff --git a/src/batch_distance.py b/src/batch_distance.py index 682e707..ec72ad7 100755 --- a/src/batch_distance.py +++ b/src/batch_distance.py @@ -1,4 +1,14 @@ # Batch_Distance.py: Batch process a bunch of distance measurements. +# ***************************************************************************** +# Copyright (c) Erbosoft Metaverse Design Solutions 2020. All Rights Reserved. +# SPDX-License-Identifier: MIT +# ***************************************************************************** +# * +# * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT +# * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN, +# * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED +# * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, +# * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. import sys import argparse diff --git a/src/dcalc.py b/src/dcalc.py index a36890f..26bcd7d 100755 --- a/src/dcalc.py +++ b/src/dcalc.py @@ -1,4 +1,14 @@ # DCalc.py: basic test of distance calculation from the Boulder office +# ***************************************************************************** +# Copyright (c) Erbosoft Metaverse Design Solutions 2020. All Rights Reserved. +# SPDX-License-Identifier: MIT +# ***************************************************************************** +# * +# * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT +# * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN, +# * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED +# * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, +# * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. import sys import argparse diff --git a/src/gcoder.py b/src/gcoder.py index b058081..34e5d40 100755 --- a/src/gcoder.py +++ b/src/gcoder.py @@ -1,4 +1,14 @@ # GCoder.py: basic geocoding test +# ***************************************************************************** +# Copyright (c) Erbosoft Metaverse Design Solutions 2020. All Rights Reserved. +# SPDX-License-Identifier: MIT +# ***************************************************************************** +# * +# * DISCLAIMER. THIS PROGRAM IS PROVIDED TO YOU "AS IS" WITHOUT +# * WARRANTIES OR CONDITIONS OF ANY KIND, WHETHER ORAL OR WRITTEN, +# * EXPRESS OR IMPLIED. THE AUTHOR SPECIFICALLY DISCLAIMS ANY IMPLIED +# * WARRANTIES OR CONDITIONS OF MERCHANTABILITY, SATISFACTORY QUALITY, +# * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE. import sys import argparse