Installation and Usage

Installing in a python environment

Any release can be installed and used by running one of the following:

#Pull a specific release
pip install git+https://github.com/adsabs/[email protected]
#Install branch
pip install git+https://github.com/adsabs/SciXPipelineUtils.git@$BRANCH_NAME

Usage

The SciXPipelineUtils package currently provides the following modules

#Methods for interacting with S3 providers
SciXPipelineUtils.s3_methods
#Methods for loading configuration files and schemas
SciXPipelineUtils.utils
#Methods for Serializing and Deserializing AVRO messages using a specified schema
SciXPipelineUtils.avro_serializer
#Methods for generating Canonical SciX Identifiers
SciXPipelineUtils.scix_id
#Class wraps uuid to provide uuid7 support.
SciXPipelineUtils.scix_uuid

Setting Up a Development Environment

Installing dependencies and hooks

This project uses pyproject.toml to install necessary dependencies and otherwise set up a working development environment. To set up a local working environment, simply run the following:

virtualenv .venv
source .venv/bin/activate
pip install .[dev]
pip install .
pre-commit install
pre-commit install --hook-type commit-msg

Maintainers

Taylor Jacovich and The ADS Team