Skip to main content

A data model and validation tool for PHIR (PECOS High-level Intermediate Representation).

Project description

PHIR: PECOS High-level Intermediate Representation

PyPI version Python versions

phir models the PHIR specification as a Pydantic model. See our docs. Included is the tool phir-cli that provides validation and pretty printing on the command line.

Prerequisites

Python >=3.10

Installation

Just issue pip install phir to obtain the latest stable release.

phir CLI

The package includes a CLI for directly validating PHIR JSON files using the command line.

 phir-cli -h
usage: phir-cli [-h] [-s] [-v] [jsonfile]

Validates and pretty prints valid PHIR

positional arguments:
  jsonfile       json file to validate against PHIR spec

options:
  -h, --help     show this help message and exit
  -s, --schema   dump JSON schema of the PHIR model and exit
  -v, --version  show program's version number and exit

Development

Clone the repository and run:

python -m venv .venv
source .venv/bin/activate
pip install -U pip setuptools
pip install -r requirements.txt
pre-commit install

Then install the project using:

pip install -e .

See Makefile for other useful commands.

Testing

Issue pytest from the root directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

phir-0.1.4.tar.gz (20.9 kB view hashes)

Uploaded Source

Built Distribution

phir-0.1.4-py3-none-any.whl (10.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page