Install from source

No Loquitur package is on a package index: each one installs from a clone of its repository at the release tag. Clone the repositories you need side by side in one directory, then follow the section for each package.

git clone --branch v0.1.0 https://github.com/loquitur-dev/loquitur-schemas.git
git clone --branch v0.1.0 https://github.com/loquitur-dev/loquitur-verify-py.git
git clone --branch v0.1.0 https://github.com/loquitur-dev/loquitur-verify-ts.git

The schemas package

The package installs from a checkout of the loquitur-schemas repository. It needs Python 3.11 or later. From the directory that contains the checkout:

python -m pip install ./loquitur-schemas

That is all the package needs. It has no optional install for normal use, and importing it pulls in no web framework, no test runner and no schema-validation library.

To check the install:

loquitur-schema-validate --version

It prints loquitur-schemas 0.1.0.

Included from loquitur-schemas/README.md, “Install”. MIT OR Apache-2.0.

The Python verifier

Install loquitur-schemas first if you want the narrative extra.

You need Python 3.11 or newer and a checkout of the loquitur-verify-py repository. From the directory that contains the checkout:

python -m pip install ./loquitur-verify-py
cd loquitur-verify-py
loquitur-verify --version

That installs the verifier and its two dependencies, rfc8785 and cryptography. Network access is needed only to download them when they are not already cached.

The optional narrative extra, which adds --narrative, needs loquitur-schemas (>=0.1.0,<0.2.0): install it the same way from its own checkout, before loquitur-verify.

Included from loquitur-verify-py/README.md, “Installation”. MIT OR Apache-2.0.

The TypeScript verifier

Build a tarball from a clone of loquitur-verify-ts and install it in your project. The commands are the same in PowerShell and in a POSIX shell:

cd loquitur-verify-ts
npm ci
npm pack        # builds dist/ and writes loquitur-verify-0.1.0.tgz
cd ../your-project
npm install ../loquitur-verify-ts/loquitur-verify-0.1.0.tgz

Included from loquitur-verify-ts/README.md, “Installation”. MIT OR Apache-2.0.

To install on a machine with no network access, see Install on an offline machine.