Metadata-Version: 2.1
Name: SF_plum_finder
Version: 1.2.8
Summary: Find the closest plum in San Francisco
Author-email: Zaven Cook <zavencook@gmail.com>
License: Copyright (c) 2022 Zaven Cook
        
        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.
Project-URL: Homepage, https://github.com/zcook7904/plum_finder
Project-URL: Bug Tracker, https://github.com/zcook7904/plum_finder/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

SF_plum_finder
======

A program that finds the nearest plum trees to a given address in San Francisco

Installation
------------

To install with pip, run:

    pip install SF_plum_finder

Config
------------
To use the plum finder, a config file must be generated in the working directory. 
This is generated automatically by running the program the first time. 

### Keys
Google maps: an appropriate google maps API key must be stored here

### Settings
n: number of possible closest trees to be sent to gmaps; max = 25
usesql: not currently implemented
performance_log: logs parameters regarding the performance and entered data for each call to find_closest_plum if 
yes or True


Usage
----------
### Cloned Repository:
CLI usage can be achieved by entering:

```python src/SF_plum_finder [street address in San Francisco]```

in the working directory.

### As a module
Simple CLI use can be acheived through the following script:
```
'from SF_plum_finder import plum_finder

plum_finder.command_line_runner()'
```



Contribute
----------
If you'd like to contribute to SF_plum_finder, check out https://github.com/zcook7904/plum_finder

Tree Locations
----------
DataSF graciously hosts the entire data set of trees maintained by the Department of Public Works here: 
https://data.sfgov.org/City-Infrastructure/Street-Tree-List/tkzw-k3nqq

This data was filtered for plum trees on side walks for more manageable search and geolocations were added to trees 
with addresses that were missing them
