Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.
/ syphon Public archive
forked from ethall/syphon

A storage and management engine for CSV data.

License

Notifications You must be signed in to change notification settings

tektronix/syphon

 
 

Repository files navigation

Syphon

A CSV data storage and management engine.

build codecov CodeFactor PyPI PyPI - License

Checked with mypy Code style: black

Keithley

Syphon is a Python package that provides a simple interface to perform common tasks on labelled data. Its aim is to fit seamlessly into any automation pipeline that requires organization and collation of large datasets.

Features

  • Archive file(s) into a data storage directory.
    • Automatic archive organization based on the value of a data column (if a .schema.json file is present).
    • Quickly append new archive files onto a previously built data file.
  • Build a single data file from the contents of the archive directory.
  • Initialize new archive directories by creating a storage schema (.schema.json) file.

Basic Usage

Initialize an archive directory:

python -m syphon init ./storage/folder some_column_header "another column header"

Archive one or more files with direct paths, wildcard patterns, or a combination of both:

python -m syphon archive /path/to/data.csv ./storage/folder

python -m syphon archive /path/to/data.csv /path/to/more/*.csv ./storage/folder

Build a single data file from an archive directory:

python -m syphon build ./storage/folder all_data.csv

Archive additional data and append it to a previously built data file:

python -m syphon archive /path/to/still/more/*.csv ./storage/folder -i all_data.csv

General command line documentation and subcommand documentation can be accessed via

 python -m syphon --help

 python -m syphon SUBCOMMAND --help

Contribute

See a typo? Know how to fix an issue? Implement a requested feature?

We'd love to accept your patches and contributions! The Contributing document guides you through checkout, unit testing, and building.

Maintainer

Disclaimer

This is not an officially supported Tektronix product. It is maintained by a small group of employees in their spare time. We lack the resources typical of most Tektronix products, so please bear with us! We will do our best to address your issues and answer any questions directly related to this extension in a timely manner.

License

Copyright Keithley Instruments, LLC. All rights reserved.

Licensed under the MIT License.


Made with ❤ at Keithley Instruments