Skip to main content

Tourist Framework

Project description

Tourist🤳

PyPI version

An open-source, low-cost, serverless application for SERP extraction and web scraping.

Work on LLM projects without worrying about credits, subscriptions, or rate-limits. Tourist is a free alternative to many mainstream SERP API services. Run Tourist on your machine or deploy it into your own AWS account.

[!IMPORTANT]
Tourist is in early development. Features and API's may change unexpectedly.

Overview

tourist-architecture

Tourist has both Service and Client components. The Service (HTTP API) handles requests from the Client (your app, agent, or scraper scripts). You're in control of both components! None of your data is ever processed or stored by third parties.

Service

Local deployment (for testing...)

[!TIP]
Docker is recommended for running Tourist locally to handle dependencies for headless browsing.

  1. docker run -e X_API_KEY="whatever" -p 8000:8000 ghcr.io/pogzyb/tourist:latest

If the service came up correctly, you should see:

INFO:     Started server process [1]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)

Check the docs at http://localhost:8000/docs

AWS deployment (for real...)

Prerequisites:

  1. AWS Account and Credentials
  2. S3 Bucket for storing an OpenTofu statefile
  3. Docker Daemon

Read about the deployment container in the deploy/ folder.

Example deployment command:

docker run \
    -v /var/run/docker.sock:/var/run/docker.sock \
    --env-file .env \
    ghcr.io/pogzyb/tourist-deploy:latest \
    apply \
    -b tourist-statefile \
    -k SeCretTK3y

Use your endpoint: https://xxxxxxxx.lambda-url.us-east-1.on.aws (available the deployment outputs)

[!WARNING]
Tourist uses serverless infrastructure to keep costs extremely low; however these costs will not be $0.00 depending on how heavily you use your API.

[!IMPORTANT]
Tourist uses the X-API-KEY authorization header to protect your API, you should set this value when deploying.

Client

Build your own LLM tools, web scraping apps, or automated testing workflows with the Tourist client.

Python

You can use the python client to interact with your Tourist service. Check out the examples folder for the complete code.

pip install tourist
LLM Tools
import asyncio

from llama_index.llms.ollama import Ollama
from llama_index.core.agent.workflow import FunctionAgent
from tourist.client import TouristScraper

# Assumes you're running locally,
# change this to your lambda endpoint if you've deployed to your aws account.
tourist_scraper = TouristScraper(
    func_urls="http://localhost:8000",
    x_api_key="whatever",
)


async def search_web(query: str):
    """Search places, items, people, or current events online."""
    serp_result = await tourist_scraper.aget_serp(
        query, search_engine="duckduckgo", max_results=3
    )
    return serp_result


async def main():
    llm = Ollama(model="ministral-3:3b", request_timeout=120.0)

    agent = FunctionAgent(
        tools=[search_web],
        llm=llm,
        system_prompt="You are a helpful assistant that can search the web for information.",
        verbose=True,
    )

    response = await agent.run(
        user_msg="Which country has the most medals in the 2026 winter olympics?"
    )
    print(str(response))


if __name__ == "__main__":
    asyncio.run(main())

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tourist-0.4.2.tar.gz (367.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tourist-0.4.2-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file tourist-0.4.2.tar.gz.

File metadata

  • Download URL: tourist-0.4.2.tar.gz
  • Upload date:
  • Size: 367.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tourist-0.4.2.tar.gz
Algorithm Hash digest
SHA256 3ae268b393b8b7a801b594b33a693ac6692a2b991c14dc74c01c1325e70eea80
MD5 3a4ed5a0d28e16afbcf4b527de810f43
BLAKE2b-256 5f49e802bb689710a02d54d22cba477cb7fe289b8f3b30173465047d8fb8e22f

See more details on using hashes here.

File details

Details for the file tourist-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: tourist-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for tourist-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a1c14233eafd1f95501e774a7c6e0324f3e1b9b9a2ffe8c6c666f7df070fd0db
MD5 96978d6a594693655acf0ef6c4899cde
BLAKE2b-256 52ac87140fe1a73a9dad670babd1da786a9831d9b43b324502f9a6a86a16265f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page