Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
library_usage.py
library_usage.py
 
 
requirements.txt
requirements.txt
 
 

README.md

GeoSpy Library Examples

This directory contains simple examples showing how to use GeoSpy as a library.

Setup

  1. Install the required dependencies:

    pip install -r requirements.txt

  2. Set your Gemini API key:

    export GEMINI_API_KEY="your-api-key-here"

    On Windows:

    set GEMINI_API_KEY=your-api-key-here

Library Usage

GeoSpy returns a JSON object that you can use in your application. Here's how to use it:

from geospyer import GeoSpy

# Initialize
geospy = GeoSpy()  # Uses GEMINI_API_KEY from environment

# Analyze an image and get the result JSON
result = geospy.locate(image_path="your_image.jpg")

# The result is a JSON object you can work with
if "error" in result:
    # Handle errors
    print(f"Error: {result['error']}")
else:
    # Work with the data
    locations = result.get("locations", [])
    if locations:
        top_location = locations[0]
        print(f"Location: {top_location.get('city')}, {top_location.get('country')}")

Accessing the JSON Data

The result object contains these main sections:

  1. interpretation: Analysis of the image
  2. locations: Array of possible locations, ordered by confidence

Example of accessing location data:

# Get coordinates for Google Maps
if "locations" in result and result["locations"]:
    location = result["locations"][0]
    
    if "coordinates" in location:
        lat = location["coordinates"].get("latitude")
        lng = location["coordinates"].get("longitude")
        maps_url = f"https://www.google.com/maps?q={lat},{lng}"

Saving to a File

You can easily save the results to a JSON file:

import json

with open("result.json", "w") as f:
    json.dump(result, f, indent=2)

Run the Example

python library_usage.py

This will analyze an image and save the results to geospy_result.json without printing to the console.

Examples

Basic Library Usage

The library_usage.py file shows the simplest way to use GeoSpy:

from geospyer import GeoSpy

# Initialize
geospy = GeoSpy()  # Uses GEMINI_API_KEY from environment

# Analyze an image
result = geospy.locate(image_path="your_image.jpg")

# Print results
print(result)

Run the example with:

python library_usage.py

Simple API

The simple_api.py file shows a minimal Flask API:

from flask import Flask, request, jsonify
from geospyer import GeoSpy

app = Flask(__name__)
geospy = GeoSpy()

@app.route('/analyze', methods=['POST'])
def analyze():
    data = request.json
    image_url = data['image_url']
    
    result = geospy.locate(image_path=image_url)
    return jsonify(result)

if __name__ == '__main__':
    app.run(debug=True, port=5000)

Run it with:

python simple_api.py

Test it with:

curl -X POST http://localhost:5000/analyze \
  -H "Content-Type: application/json" \
  -d '{"image_url": "https://example.com/image.jpg"}'

Using in Your Projects

To use GeoSpy in your own projects:

  1. Install the package:

    pip install geospyer

  2. Import and initialize:

    from geospyer import GeoSpy

# Initialize with API key
geospy = GeoSpy(api_key="your-api-key-here")

# Or use from environment variable
# geospy = GeoSpy()

  3. Analyze images:

    results = geospy.locate(
    image_path="path/to/image.jpg",
    context_info="Optional context",
    location_guess="Optional guess"
)