Config

---

pyravelry.settings.RavelrySettings

Bases: BaseSettings

Initializes the settings from which to call the Ravelry API.

Attributes:

Name	Type	Description
auth_tuple	tuple[str, str]	formatted Revelry auth tuple for httpx.

Parameters:

Name	Type	Description	Default
ravelry_auth_username	str		required
ravelry_auth_api_key	SecretStr		required
base_url	HttpUrl		HttpUrl('https://api.ravelry.com/')

Source code in src/pyravelry/settings.py

class RavelrySettings(BaseSettings):
    """Initializes the settings from which to call the Ravelry API.

    Attributes:
        ravelry_auth_username (str): username for Ravelry.
        ravelry_auth_api_key (SecretStr): read-only API token for accessing Ravelry.
        auth_tuple (tuple[str, str]): formatted Revelry auth tuple for httpx.
    """

    # Use the 'read-only' credentials from your Ravelry App control panel
    ravelry_auth_username: str = Field(..., alias="RAVELRY_USERNAME")
    ravelry_auth_api_key: SecretStr = Field(..., alias="RAVELRY_API_KEY")

    # The API requires SSL (HTTPS) for all requests
    base_url: HttpUrl = HttpUrl("https://api.ravelry.com")

    # Configuration to read from a .env file
    model_config = SettingsConfigDict(env_file=".env", extra="ignore")

    @property
    def auth_tuple(self) -> tuple[str, str]:
        """Returns credentials in the (username, password) format for httpx."""
        return (
            self.ravelry_auth_username,
            self.ravelry_auth_api_key.get_secret_value(),
        )

pyravelry.settings.RavelrySettings.auth_tuple property

Returns credentials in the (username, password) format for httpx.

---

pyravelry.client.RavelryClient

Client to get data from the revelry api.

Attributes:

Name	Type	Description
settings	RavelrySettings	Authentication for the Ravelry API.
_http	SyncCacheClient	Httpx client with persistent caching
color_families	ColorFamiliesResource	Color Families endpoint
fiber_categories	FiberCategoriesResource	Fiber Categories endpoint
yarn_weights	YarnWeightsResource	Yarn Weights endpoint
search	SearchResource	Search endpoint
fiber_attributes	FiberAttributesResource	Fiber Attributes endpoint
yarn_companies	YarnCompaniesResource	Yarn Companies endpoint

Source code in src/pyravelry/client.py

class RavelryClient:
    """Client to get data from the revelry api.

    Attributes:
        settings (RavelrySettings): Authentication for the Ravelry API.
        _http (SyncCacheClient): Httpx client with persistent caching
        color_families (ColorFamiliesResource): Color Families endpoint
        fiber_categories (FiberCategoriesResource): Fiber Categories endpoint
        yarn_weights (YarnWeightsResource): Yarn Weights endpoint
        search (SearchResource): Search endpoint
        fiber_attributes (FiberAttributesResource): Fiber Attributes endpoint
        yarn_companies (YarnCompaniesResource): Yarn Companies endpoint
    """

    def __init__(self, settings: RavelrySettings) -> None:
        """Instantiates a revelry httpx client.

        Args:
            settings (RavelrySettings): Authentication and other settings.
        """
        self.settings = settings
        # Initialize the persistent httpx client with auth
        self._http = SyncCacheClient(
            base_url=str(settings.base_url),
            auth=settings.auth_tuple,
            timeout=10.0,
        )
        self.color_families = ColorFamiliesResource(self._http)
        self.fiber_categories = FiberCategoriesResource(self._http)
        self.yarn_weights = YarnWeightsResource(self._http)
        self.yarn_attributes = YarnAttributesResource(self._http)
        self.search = SearchResource(self._http)
        self.fiber_attributes = FiberAttributesResource(self._http)
        self.yarn_companies = YarnCompaniesResource(self._http)
        self.people = PeopleResource(self._http)
        self.current_user = CurrentUserResource(self._http)

    def close(self) -> None:
        """Closes the httpx client."""
        self._http.close()

    def __enter__(self) -> Self:
        """Method to enter context manager."""
        return self

    def __exit__(
        self,
        exc_type: Optional[type[BaseException]],
        exc_val: Optional[BaseException],
        exc_tb: Optional[TracebackType],
    ) -> None:
        """Method to exit context manager, ensuring the client is closed."""
        self.close()

pyravelry.client.RavelryClient.__enter__()

Method to enter context manager.

Source code in src/pyravelry/client.py

def __enter__(self) -> Self:
    """Method to enter context manager."""
    return self

pyravelry.client.RavelryClient.__exit__(exc_type, exc_val, exc_tb)

Method to exit context manager, ensuring the client is closed.

Source code in src/pyravelry/client.py

def __exit__(
    self,
    exc_type: Optional[type[BaseException]],
    exc_val: Optional[BaseException],
    exc_tb: Optional[TracebackType],
) -> None:
    """Method to exit context manager, ensuring the client is closed."""
    self.close()

pyravelry.client.RavelryClient.__init__(settings)

Instantiates a revelry httpx client.

Parameters:

Name	Type	Description	Default
settings	RavelrySettings	Authentication and other settings.	required

Source code in src/pyravelry/client.py

def __init__(self, settings: RavelrySettings) -> None:
    """Instantiates a revelry httpx client.

    Args:
        settings (RavelrySettings): Authentication and other settings.
    """
    self.settings = settings
    # Initialize the persistent httpx client with auth
    self._http = SyncCacheClient(
        base_url=str(settings.base_url),
        auth=settings.auth_tuple,
        timeout=10.0,
    )
    self.color_families = ColorFamiliesResource(self._http)
    self.fiber_categories = FiberCategoriesResource(self._http)
    self.yarn_weights = YarnWeightsResource(self._http)
    self.yarn_attributes = YarnAttributesResource(self._http)
    self.search = SearchResource(self._http)
    self.fiber_attributes = FiberAttributesResource(self._http)
    self.yarn_companies = YarnCompaniesResource(self._http)
    self.people = PeopleResource(self._http)
    self.current_user = CurrentUserResource(self._http)

pyravelry.client.RavelryClient.close()

Closes the httpx client.

Source code in src/pyravelry/client.py

def close(self) -> None:
    """Closes the httpx client."""
    self._http.close()