Skip to main content

Data transformation framework for LinkML data models

Project description

Koza - a data transformation framework Pyversions PyPi

pupa

Documentation: https://koza.monarchinitiative.org/

Disclaimer: Koza is in beta; we are looking for beta testers

Overview

  • Transform csv, json, yaml, jsonl, and xml and converting them to a target csv, json, or jsonl format based on your dataclass model.
  • Koza also can output data in the KGX format
  • Write data transforms in semi-declarative Python
  • Configure source files, expected columns/json properties and path filters, field filters, and metadata in yaml
  • Create or import mapping files to be used in ingests (eg id mapping, type mappings)
  • Create and use translation tables to map between source and target vocabularies

Installation

Koza is available on PyPi and can be installed via pip:

pip install koza

Usage

NOTE: As of version 0.2.0, there is a new method for getting your ingest's KozaApp instance. Please see the updated documentation for details.

See the Koza documentation for usage information

Try the Examples

Validate

Give Koza a local or remote csv file, and get some basic information (headers, number of rows)

koza validate \
  --file https://raw.githubusercontent.com/monarch-initiative/koza/main/examples/data/string.tsv \
  --delimiter ' '

Sending a json or jsonl formatted file will confirm if the file is valid json or jsonl

koza validate \
  --file ./examples/data/ZFIN_PHENOTYPE_0.jsonl.gz \
  --format jsonl
koza validate \
  --file ./examples/data/ddpheno.json.gz \
  --format json \
  --compression gzip

Transform

Run the example ingest, "string/protein-links-detailed"

koza transform --source examples/string/protein-links-detailed.yaml --global-table examples/translation_table.yaml

koza transform --source examples/string-declarative/protein-links-detailed.yaml --global-table examples/translation_table.yaml

note: koza expects a directory structure as described in the above example (examples/ingest_name/ingest.yaml)

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

koza-0.2.3.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

koza-0.2.3-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file koza-0.2.3.tar.gz.

File metadata

  • Download URL: koza-0.2.3.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure

File hashes

Hashes for koza-0.2.3.tar.gz
Algorithm Hash digest
SHA256 4a6f1a5bf4e0a832504ef682e86484c27eb21187673197bbcd34fc83f9c5a66f
MD5 60376ec073e9094c674dbcccae50c6fe
BLAKE2b-256 c8f2a5bd665a01cb69ab95e27a23d3cfb173a8ca92e1e173d11077422ece5a7c

See more details on using hashes here.

File details

Details for the file koza-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: koza-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.2 CPython/3.10.8 Linux/5.15.0-1022-azure

File hashes

Hashes for koza-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e343cbd95845a544dcb610332325a9d050e01b2721799c1359ead85c795320
MD5 7081447034a07c9b9865de250fe046c5
BLAKE2b-256 68206bdf53a17d97f96cb4027a1f951aae71687a68a12477921eccd1f91119fe

See more details on using hashes here.

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