fleshed out README, added MIT license and license headers in the code
This commit is contained in:
parent
5b0a0768cb
commit
85f18d2518
21
LICENSE.md
Executable file
21
LICENSE.md
Executable file
|
@ -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.
|
17
README.md
17
README.md
|
@ -1,3 +1,18 @@
|
||||||
# distance-calc
|
# distance-calc
|
||||||
|
|
||||||
Python-based distance calculator to help determine how far new apartment complexes are from the office.
|
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.
|
||||||
|
|
|
@ -1,4 +1,14 @@
|
||||||
# Batch_Distance.py: Batch process a bunch of distance measurements.
|
# 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 sys
|
||||||
import argparse
|
import argparse
|
||||||
|
|
10
src/dcalc.py
10
src/dcalc.py
|
@ -1,4 +1,14 @@
|
||||||
# DCalc.py: basic test of distance calculation from the Boulder office
|
# 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 sys
|
||||||
import argparse
|
import argparse
|
||||||
|
|
|
@ -1,4 +1,14 @@
|
||||||
# GCoder.py: basic geocoding test
|
# 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 sys
|
||||||
import argparse
|
import argparse
|
||||||
|
|
Loading…
Reference in New Issue
Block a user