installation.md

:simple-pypi: Installation

Install PyLD from PyPI:

pip install PyLD

PyLD's core package does not install requests or aiohttp automatically. If your application needs one of the built-in remote document loaders, install the matching extra:

pip install "PyLD[requests]"
pip install "PyLD[aiohttp]"
pip install "PyLD[requests-cache]"
pip install "PyLD[cli]"

PyLD[cli] installs :simple-typer: Typer and :simple-pypi: requests-cache, and registers the pyld console script.

You can also depend on requests or aiohttp directly if your project already manages those dependencies.

Development Install

From a local checkout:

pip install -e .

Run the project tests with:

pytest

The JSON-LD specification test suites are stored under specifications/ and are usually initialized as git submodules:

git submodule init
git submodule update