feat: add --debug flag, improve logging & help

closes #9
This commit is contained in:
Felix Spöttel
2022-07-01 17:53:09 +02:00
parent 4dfa08bbbc
commit cff5256d06
3 changed files with 49 additions and 5 deletions

View File

@@ -39,6 +39,12 @@ pip install .
```
Usage: geoclustering [OPTIONS] FILENAME
Tool to cluster geolocations. A cluster is created when a certain number of
points (--size) each are within a given distance (--distance) of at least
one other point in the cluster. Input is supplied as a csv file. At a
minimum, each row needs to have a 'lat' and a 'lon' column. Other rows are
reflected to the output.
Options:
-d, --distance FLOAT (in km) Max. distance between two points in
a cluster. [required]
@@ -52,6 +58,7 @@ Options:
Default: dbscan
--open Open the generated visualization in the
default browser automatically.
--debug Print debug output.
--help Show this message and exit.
```