leadminer 0.1.0__tar.gz

leadminer-0.1.0/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: leadminer
+Version: 0.1.0
+Summary: CLI tool for finding local business leads
+Requires-Dist: requests
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Requires-Dist: typer

leadminer-0.1.0/campaigns.py

@@ -0,0 +1,52 @@
+import database
+from database import *
+from dotenv import load_dotenv, set_key, get_key
+import os
+import typer
+
+
+def campaign(command: str =typer.Argument(...), option: str | None = typer.Argument(None)):
+
+    if command == "create":
+        #check valid name
+
+        make_campaign(option)
+
+    elif command == "select":
+        campaign_id = get_campaign_id(option)
+        if campaign_id:
+            load_dotenv(".env")
+            set_key(".env", "ACTIVE_CAMPAIGN_NAME", option)
+            set_key(".env", "ACTIVE_CAMPAIGN_ID", str(campaign_id))
+        else:
+            print("That campaign does not exist")
+
+    elif command == "list":
+        if option:
+            campaign_id = get_campaign_id(option)
+            if campaign_id:
+                #handle listing the data from campaign
+                list_campaign_data(option)
+            else:
+                print("That campaign does not exist")
+        else:
+            # list all the campaigns
+            list_campaigns()
+
+    elif command == "remove":
+        campaign_id = get_campaign_id(option)
+        if campaign_id:
+            # remove the campaign
+            remove_campaign(option)
+        else: print("That campaign does not exist")
+
+    elif command == "disconnect":
+        load_dotenv(".env")
+        exists = get_key(".env", "ACTIVE_CAMPAIGN_NAME")
+        if exists:
+            set_key(".env", "ACTIVE_CAMPAIGN_NAME", "")
+            set_key(".env", "ACTIVE_CAMPAIGN_ID", "")
+        else: print("You are not currently connected to a campaign")
+
+    else:
+        print(f"\"{option}\" is not a recognised command")

leadminer-0.1.0/classes.py

@@ -0,0 +1,18 @@
+"""place["id"],
+        place["displayName"]["text"],
+        place["formattedAddress"],
+        place.get("rating"),
+        place.get("userRatingCount"),"""
+from numbers import Real
+
+
+class Lead:
+    def __init__(self, place_id: str, name: str, address: str, phone: str, website: str, rating: float, reviews: int):
+        self.placeId: str = place_id
+        self.name: str = name
+        self.address: str = address
+        self.phone: str = phone
+        self.website: str = website
+        self.rating: float = rating
+        self.reviews: int = reviews
+

leadminer-0.1.0/database.py

@@ -0,0 +1,148 @@
+import sqlite3
+from pathlib import Path
+import classes
+
+from output import output_cli
+
+database_path = Path.home() / ".leadminer" / "leadminer.db"
+
+def sort_database():
+    database_path.parent.mkdir(exist_ok=True)
+    connection = sqlite3.connect(database_path)
+    return connection
+
+
+def make_tables():
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute("""
+    CREATE TABLE IF NOT EXISTS campaigns (
+        id INTEGER PRIMARY KEY AUTOINCREMENT,
+        name TEXT UNIQUE
+    )
+    """)
+
+    cursor.execute("""
+    CREATE TABLE IF NOT EXISTS leads (
+        place_id TEXT PRIMARY KEY,
+        name TEXT,
+        address TEXT,
+        website TEXT,
+        phone TEXT,
+        rating REAL,
+        reviews INTEGER,
+        campaign_id INTEGER,
+        FOREIGN KEY (campaign_id) REFERENCES campaigns(id)
+    )
+    """)
+
+    connection.commit()
+    connection.close()
+
+def make_campaign(name: str):
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute(
+    "INSERT INTO campaigns (name) VALUES (?)",
+        (name,)
+    )
+
+    connection.commit()
+    connection.close()
+
+def remove_campaign(name: str):
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute(
+        "DELETE FROM campaigns WHERE name = ?", (name,)
+    )
+
+    connection.commit()
+    connection.close()
+
+def list_campaigns():
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute(
+        "SELECT name from campaigns"
+    )
+
+    rows = cursor.fetchall()
+
+    for row in rows:
+        print(row[0])
+
+    connection.close()
+
+def get_campaign_id(name: str):
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute(
+        "SELECT id FROM campaigns WHERE name = ?",
+        (name,)
+    )
+
+    result = cursor.fetchone()
+    connection.close()
+
+    if result is not None:
+        return result[0]
+    else:
+        return None
+
+def save_lead(place, campaign_name):
+
+    campaign_id = get_campaign_id(campaign_name)
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute("""
+    INSERT OR IGNORE INTO leads
+    (place_id, name, address, phone, website, rating, reviews, campaign_id)
+    VALUES (?,?,?,?,?,?,?,?)
+    """, (
+        place.placeId,
+        place.name,
+        place.address,
+        place.phone,
+        place.website,
+        place.rating,
+        place.reviews,
+        campaign_id
+    ))
+
+    connection.commit()
+    connection.close()
+
+def list_campaign_data(name: str):
+    connection = sort_database()
+    cursor = connection.cursor()
+
+    cursor.execute("""
+    SELECT leads.name, leads.address, leads.phone, leads.website, leads.rating, leads.reviews
+    FROM leads
+    JOIN campaigns ON leads.campaign_id = campaigns.id
+    WHERE campaigns.name = ?
+    """, (name,))
+
+    rows = cursor.fetchall()
+    output = []
+    for row in rows:
+        row_name = row[0]
+        row_address = row[1]
+        row_phone = row[2]
+        row_site = row[3]
+        row_rating = row[4]
+        row_reviews = row[5]
+        temp = classes.Lead("n/a", row_name, row_address, row_phone, row_site, row_rating, row_reviews)
+        output.append(temp)
+    output_cli(output)
+
+    connection.close()
+
+make_tables()

leadminer-0.1.0/help.py

@@ -0,0 +1,47 @@
+def help():
+    print("""
+    Search
+        
+        Used to search for businesses.
+    
+        Default Usage:
+            search <business-type> <area> for default search e.g. \"search Barber London\"
+        Additional Filters:
+            - website (y / n)
+            - min-rating (0-5)
+            - max-rating (0-5)
+            - min-reviews
+            - max-reviews
+            - output-format (cli / csv)
+        Examples:
+            search electrician london --output-format csv
+            search restaurant croydon --website n
+            search cafe manchester --min-rating 0 --max-rating 3
+    
+    Campaigns
+        
+        Used to store businesses that you've found under categories
+        
+        Create campaign:
+            campaign create <name>
+        Select campaign (searches will be stored under this campaign):
+            campaign select <name>
+        Stop storing searches:
+            campaign disconnect
+        Delete campaign:
+            campaign remove <name>
+        List all campaigns:
+            campaign list
+        List all data within a campaign:
+            campaign list <name>
+            
+    Setup
+        
+        Set API key:
+            setup key <api_key>
+        Learn how to find your API key:
+            setup key
+        Set limit of businesses returned to you per search:
+            setup limit <limit>
+            
+    """)

leadminer-0.1.0/leadminer.egg-info/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: leadminer
+Version: 0.1.0
+Summary: CLI tool for finding local business leads
+Requires-Dist: requests
+Requires-Dist: python-dotenv
+Requires-Dist: rich
+Requires-Dist: typer

leadminer-0.1.0/leadminer.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+campaigns.py
+classes.py
+database.py
+help.py
+main.py
+output.py
+pyproject.toml
+search.py
+setup_cmd.py
+leadminer.egg-info/PKG-INFO
+leadminer.egg-info/SOURCES.txt
+leadminer.egg-info/dependency_links.txt
+leadminer.egg-info/entry_points.txt
+leadminer.egg-info/requires.txt
+leadminer.egg-info/top_level.txt

leadminer-0.1.0/leadminer.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

leadminer-0.1.0/leadminer.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+leadminer = main:app

leadminer-0.1.0/leadminer.egg-info/requires.txt

@@ -0,0 +1,4 @@
+requests
+python-dotenv
+rich
+typer

leadminer-0.1.0/leadminer.egg-info/top_level.txt

@@ -0,0 +1,8 @@
+campaigns
+classes
+database
+help
+main
+output
+search
+setup_cmd

leadminer-0.1.0/main.py

@@ -0,0 +1,37 @@
+import typer
+from dotenv import load_dotenv, set_key
+import os
+from pathlib import Path
+
+from search import search
+from output import output
+from setup_cmd import setup
+from help import help
+from campaigns import campaign
+
+def nit():
+    # check that .env exists otherwise create
+    if not os.path.exists(".env"):
+       Path(".env").touch()
+
+    load_dotenv(".env")
+
+    searchLimit = os.getenv("LIMIT")
+    places_api_key = os.getenv("API_KEY")
+
+    # if no limit set
+    if searchLimit is None:
+        set_key(".env", "LIMIT", "100")
+
+app = typer.Typer()
+
+# search
+app.command()(search)
+app.command()(output)
+app.command()(help)
+app.command()(campaign)
+app.command()(setup)
+
+nit()
+if __name__ == "__main__":
+    app()

leadminer-0.1.0/output.py

@@ -0,0 +1,66 @@
+import csv
+import rich
+from rich.table import Table
+from rich.console import Console
+from pathlib import Path
+
+def output_cli(leads):
+    console = Console()
+
+    table = Table(title="Leads")
+
+    table.add_column("Name", style="cyan")
+    table.add_column("Address", style="green")
+    table.add_column("Phone")
+    table.add_column("Website")
+    table.add_column("Rating")
+    table.add_column("Reviews")
+
+    for lead in leads:
+        table.add_row(
+            lead.name,
+            lead.address,
+            str(lead.phone or ""),
+            str(lead.website or ""),
+            str(lead.rating or ""),
+            str(lead.reviews or "")
+        )
+
+    console.print(table)
+
+def output_csv(leads, filename="leads.csv"):
+
+    export_dir = Path.home() / ".leadminer" / "exports"
+    export_dir.mkdir(exist_ok=True)
+
+    filepath = export_dir / filename
+
+    with open(filepath, "w", newline="") as f:
+        writer = csv.writer(f)
+
+        writer.writerow([
+            "name",
+            "address",
+            "phone",
+            "website",
+            "rating",
+            "reviews"
+        ])
+
+        for lead in leads:
+            writer.writerow([
+                lead.name,
+                lead.address,
+                lead.phone,
+                lead.website,
+                lead.rating,
+                lead.reviews
+            ])
+    print(f"Exported CSV to {filepath}")
+
+def output(option: str, leads):
+    if option == "csv":
+        output_csv(leads)
+
+    elif option == "cli":
+        output_cli(leads)

leadminer-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "leadminer"
+version = "0.1.0"
+description = "CLI tool for finding local business leads"
+dependencies = [
+    "requests",
+    "python-dotenv",
+    "rich",
+    "typer"
+]
+
+[project.scripts]
+leadminer = "main:app"
+
+[tool.setuptools]
+py-modules = [
+    "main",
+    "search",
+    "output",
+    "setup_cmd",
+    "help",
+    "campaigns",
+    "database",
+    "classes",
+]

leadminer-0.1.0/search.py

@@ -0,0 +1,89 @@
+import requests, os
+from dotenv import load_dotenv, get_key
+import classes
+from database import save_lead
+import output as output_functions
+
+url = "https://places.googleapis.com/v1/places:searchText"
+
+load_dotenv(".env")
+searchLimit = os.getenv("LIMIT")
+places_api_key = os.getenv("API_KEY")
+
+def search(
+        business_type: str,
+        location: str,
+        website: str = "a",
+        min_rating: float = 0,
+        max_rating: float = 5,
+        limit: int | None = searchLimit,
+        min_reviews: int = 0,
+        max_reviews: int = 999999999,
+        output_format: str = "cli",
+        api_key: str | None = places_api_key):
+
+    # print(limit, api_key)
+
+    all_good = True
+    while all_good:
+        if api_key is None:
+            print("You have not set an API key, please set one using 'setup key <api_key>'")
+            all_good = False
+        if limit is None:
+            print("You have not set a search limit, please set one using 'setup limit <limit>'")
+            all_good = False
+
+        query = f"{business_type} in {location}"
+
+        headers = {
+            "Content-Type": "application/json",
+            "X-Goog-Api-Key": api_key,
+            "X-Goog-FieldMask": "places.id,places.displayName,places.formattedAddress,places.rating,places.userRatingCount,places.websiteUri,places.nationalPhoneNumber"
+        }
+
+        data = {
+            "textQuery": query,
+            "pageSize": limit
+        }
+
+        response = requests.post(url, headers=headers, json=data)
+        results = response.json()
+
+        object_results = []
+        campaign_active = get_key(".env", "ACTIVE_CAMPAIGN_NAME")
+
+        for place in results["places"]:
+            place_id = place["id"]
+            place_name = place["displayName"]["text"]
+            place_address = place["formattedAddress"]
+            place_rating = place.get("rating")
+            place_reviews = place.get("userRatingCount")
+            websiteUrl = place.get("websiteUri")
+            place_phone = place.get("nationalPhoneNumber")
+
+            temp = classes.Lead(place_id, place_name, place_address, place_phone, websiteUrl, place_rating, place_reviews)
+            object_results.append(temp)
+            output = []
+
+        for lead in object_results:
+            valid = True
+            if not (website == "a" or (website == "y" and lead.website) or (website == "n" and not lead.website)):
+                valid = False
+            if min_rating > lead.rating:
+                valid = False
+            if max_rating < lead.rating:
+                valid = False
+            if min_reviews > lead.reviews:
+                valid = False
+            if max_reviews < lead.reviews:
+                valid = False
+            if valid:
+                output.append(lead)
+                if campaign_active:
+                    save_lead(lead, campaign_active)
+
+        if output_format == "cli":
+            output_functions.output_cli(output)
+        elif output_format == "csv":
+            output_functions.output_csv(output)
+        all_good = False

leadminer-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

leadminer-0.1.0/setup_cmd.py

@@ -0,0 +1,30 @@
+import typer
+from dotenv import load_dotenv, set_key
+
+# setup command
+    # setup places api key
+    # set max limit
+
+
+
+def setup(choice: str = typer.Argument(...), value: str | None = typer.Argument(None)):
+
+    if choice == "key" and value:
+        set_key(".env", "API_KEY", value)
+    elif choice == "limit":
+        set_key(".env", "LIMIT", value)
+
+    elif choice == "key" and not value:
+        print("""
+        To use leadminer, you need a Google Places API key.
+        
+        1. Go to this link, sign in, and click "enable":
+        https://console.cloud.google.com/apis/library/places-backend.googleapis.com
+
+        2. Create an API key:
+        https://console.cloud.google.com/apis/credentials
+        
+        3. Copy the key and run:
+        leadminer setup key <YOUR_API_KEY>
+        """)
+