apeye-core

Warnings

• gotcha `apeye-core` is primarily intended as an internal dependency for the `apeye` library. End-users seeking functionality for working with URLs, APIs, caching, or rate limiting should typically install and use the `apeye` library, not `apeye-core` directly.
  Fix: Install `apeye` (`pip install apeye`) for a full set of tools and refer to its documentation for usage examples.
• gotcha The release notes for `apeye-core` often simply state 'Automatically copied from PyPI', providing minimal detail about specific changes or potential breaking changes between minor versions. Users should exercise caution and review changes if upgrading across several minor versions.
  Fix: Consult the GitHub repository's commit history or the `apeye` library's documentation for more detailed insights into specific changes.

Install

• pip install apeye-core Install with pip
• conda install -c conda-forge apeye-core Install with Conda

Imports

• URL

  from apeye.url import URL

  While underlying components may reside in `apeye-core`, direct end-user imports are typically from the `apeye` library which re-exports or builds upon `apeye-core`'s functionality. For example, the `URL` object, a core concept, is exposed via `apeye`.

Quickstart

apeye-core provides foundational, offline functionality. For most user-facing interactions, such as creating URL objects or utilizing API tools, you should typically use the higher-level `apeye` library, which depends on `apeye-core`. This quickstart demonstrates a core component (URL) as exposed by `apeye`.

import os
from apeye.url import URL

# apeye-core itself is primarily an internal dependency.
# Most user-facing functionality is exposed via the 'apeye' library.
# Here's an example of using a core component (URL) from 'apeye' that likely leverages apeye-core.

my_url = URL('https://example.com/api/data')
print(f"Created URL object: {my_url}")
print(f"URL scheme: {my_url.scheme}")
print(f"URL hostname: {my_url.hostname}")

# To see the full capabilities of apeye (which uses apeye-core),
# install 'apeye' and refer to its documentation for features like caching and rate limiting.
# pip install apeye