Skip to content

gracy

239 2 - MIT
1.33.0 (20 Feb 2024) Feb 05 2023 895 (month)

Gracy is an API client library based on httpx that provides an extra stability layer with:

  • Retry logic
  • Logging
  • Connection throttling
  • Tracking/Middleware

In web scraping, Gracy can be a convenient tool for creating scraper based API clients.

Example Use


# 0. Import
import asyncio
from typing import Awaitable
from gracy import BaseEndpoint, Gracy, GracyConfig, LogEvent, LogLevel

# 1. Define your endpoints
class PokeApiEndpoint(BaseEndpoint):
    GET_POKEMON = "/pokemon/{NAME}" # 👈 Put placeholders as needed

# 2. Define your Graceful API
class GracefulPokeAPI(Gracy[str]):
    class Config:  # type: ignore
        BASE_URL = "https://pokeapi.co/api/v2/" # 👈 Optional BASE_URL
        # 👇 Define settings to apply for every request
        SETTINGS = GracyConfig(
          log_request=LogEvent(LogLevel.DEBUG),
          log_response=LogEvent(LogLevel.INFO, "{URL} took {ELAPSED}"),
          parser={
            "default": lambda r: r.json()
          }
        )

    async def get_pokemon(self, name: str) -> Awaitable[dict]:
        return await self.get(PokeApiEndpoint.GET_POKEMON, {"NAME": name})

    # Note: since Gracy is based on httpx we can customized the used client with custom headers etc"
    def _create_client(self) -> httpx.AsyncClient:
        client = super()._create_client()
        client.headers = {"User-Agent": f"My Scraper"} 
        return client

pokeapi = GracefulPokeAPI()

async def main():
    try:
      pokemon = await pokeapi.get_pokemon("pikachu")
      print(pokemon)

    finally:
        pokeapi.report_status("rich")


asyncio.run(main())

Alternatives / Similar


51,221 2.11.2 (12 days ago) Jul 26 2019 compare
2,862 1.4.3 (8 months ago) Sep 04 2013 compare
5,994 1.1.14 (1 year, 10 months ago) Jul 26 2019 compare
3,015 1.5.0 (3 months ago) Sep 30 2018 compare
3,229 0.9.13 (10 months ago) Jul 04 2017 compare
1,734 0.8.5 (1 year, 8 months ago) Oct 17 2018 compare
10,575 1.1.9 (5 years ago) Aug 24 2018 compare
412 0.1.3 (9 months ago) Feb 20 2022 compare

Other Languages

22,347 v2.1.0 (3 years ago) May 14 2018 compare
7,533 v1.3.4 (4 years ago) Feb 15 2020 compare
2,488 2024-05-09 (17 days ago) Jun 06 2019 compare
645 2024-05-11 (15 days ago) Feb 09 2017 compare
1,479 1.0.4 (1 year, 9 months ago) Nov 22 2014 compare
5,641 v0.18.0 (1 year, 1 month ago) Aug 06 2019 compare
2,025 (3 years ago) Nov 20 2016 compare
6,630 1.5.0 (11 days ago) Sep 10 2012 compare
2,892 v2.1.1 (5 months ago) Jul 17 2018 compare
793 0.7.1 (4 months ago) Jul 25 2009 compare
1,305 3.0.0 (1 year, 9 months ago) Dec 27 2011 compare
152 2.2.4 (3 years ago) Dec 22 2019 compare
1,327 v3.2.0 (a month ago) Dec 27 2021 compare
198 1.0.0-beta8.4 (10 months ago) Apr 18 2019 compare
498 3.0.0 (a month ago) May 04 2020 compare
1,325 v0.7.2 (5 months ago) Mar 16 2013 compare
300 v1.7.2 (2 months ago) Apr 18 2022 compare
Was this page helpful?