Skip to content

gracy

224 2 2 MIT
1.27.1 (8 Aug 2023) Feb 05 2023 214 (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


49,364 2.11.0 (2 months ago) Jul 26 2019 compare
2,734 1.4.3 (2 months ago) Sep 04 2013 compare
5,654 1.1.14 (1 year, 4 months ago) Jul 26 2019 compare
1,701 0.8.5 (1 year, 2 months ago) Oct 17 2018 compare
2,864 1.4.1 (2 months ago) Sep 30 2018 compare
3,118 0.9.13 (4 months ago) Jul 04 2017 compare
10,120 1.1.9 (5 years ago) Aug 24 2018 compare
386 0.1.3 (3 months ago) Feb 20 2022 compare

Other Languages

21,215 v2.1.0 (3 years ago) May 14 2018 compare
7,476 v1.3.4 (3 years ago) Feb 15 2020 compare
2,296 2023-11-24 (4 days ago) Jun 06 2019 compare
622 2023-11-24 (4 days ago) Feb 09 2017 compare
1,428 1.0.3 (2 years ago) Nov 22 2014 compare
6,541 1.4.0 (10 months ago) Sep 10 2012 compare
5,513 v0.18.0 (8 months ago) Aug 06 2019 compare
2,021 (2 years ago) Nov 20 2016 compare
2,829 v2.1.0 (5 months ago) Jul 17 2018 compare
1,298 3.0.0 (1 year, 3 months ago) Dec 27 2011 compare
769 0.7.0 (10 months ago) Jul 25 2009 compare
150 2.2.4 (2 years ago) Dec 22 2019 compare
1,271 2.0.1 (9 months ago) Dec 27 2021 compare
443 2.0.0 (5 months ago) May 04 2020 compare
1,312 v0.7.1 (3 months ago) Mar 16 2013 compare
186 1.0.0-beta8.4 (5 months ago) Apr 18 2019 compare
277 v1.3.0 (a month ago) Apr 18 2022 compare