Skip to main content

Utilities for Bootstrapping Validation Components

Project description

Utilities for Bootstrapping Validation Components

Utilities for Bootstrapping Validation Components

Validation Component Bootstrap Utils is a comprehensive set of Python scripts and utilities designed to streamline the process of parsing and validating tab-delimited or comma-separated files. This toolkit automates the generation of essential modules, making it easier to integrate file validation components into your projects.

Modules Generated

validator.py: This module provides a robust set of functions and classes for validating data within the specified file format. It ensures that the content adheres to defined standards, offering a solid foundation for data integrity.

parser.py: The parser module facilitates efficient extraction of data from tab-delimited or comma-separated files. It is engineered to handle various data structures and file layouts, ensuring flexibility and adaptability to diverse use cases.

record.py: The record module defines structures for organizing and representing individual records within the files. It lays the groundwork for maintaining data consistency and ease of manipulation during the parsing and validation processes.

file_validation.py: This module orchestrates the validation and parsing processes, providing a unified interface for users. It acts as the entry point for utilizing the toolkit, promoting simplicity and coherence in handling file operations.

Exported console script

  • bootstrap-validation-component - This script is the main entry point for the Validation Component Bootstrap Utils toolkit. It generates the essential modules for parsing and validating tab-delimited or comma-separated files, streamlining the integration of validation components into your projects.

Usage:

bootstrap-validation-component  --infile examples/sample.tsv --data_file_type VCF --namespace su.vcf --verbose
--config_file was not specified and therefore was set to
'/home/sundaram/projects/validation-component-bootstrap-utils/venv/lib/python3.10/site-packages/validation_component_bootstrap_utils/conf/config.yaml'
--outdir was not specified and therefore was set to '/tmp/generate_validation_module/2023-12-19-123510'
Created output directory '/tmp/generate_validation_module/2023-12-19-123510'
--template_path was not specified and therefore was set to
'/home/sundaram/projects/validation-component-bootstrap-utils/venv/lib/python3.10/site-packages/validation_component_bootstrap_utils/templates/validation'
--logfile was not specified and therefore was set to '/tmp/generate_validation_module/2023-12-19-123510/generate_validation_module.log'
Wrote validator.py file '/tmp/generate_validation_module/2023-12-19-123510/su/vcf/validator.py'
Wrote validate_file.py file '/tmp/generate_validation_module/2023-12-19-123510/validate_file.py'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/0_#CHROM.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/1_POS.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/2_ID.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/3_REF.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/4_ALT.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/5_QUAL.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/6_FILTER.tsv'
Wrote column report file '/tmp/generate_validation_module/2023-12-19-123510/7_INFO.tsv'
Wrote record.py file '/tmp/generate_validation_module/2023-12-19-123510/su/vcf/record.py'
The log file is '/tmp/generate_validation_module/2023-12-19-123510/generate_validation_module.log'
Execution of
'/home/sundaram/projects/validation-component-bootstrap-utils/venv/lib/python3.10/site-packages/validation_component_bootstrap_utils/generate_validation_module.py' completed

History

0.1.0 (2023-12-19)

  • First release on PyPI.

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

validation_component_bootstrap_utils-0.5.2.tar.gz (24.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

validation_component_bootstrap_utils-0.5.2-py2.py3-none-any.whl (30.0 kB view details)

Uploaded Python 2Python 3

File details

Details for the file validation_component_bootstrap_utils-0.5.2.tar.gz.

File metadata

File hashes

Hashes for validation_component_bootstrap_utils-0.5.2.tar.gz
Algorithm Hash digest
SHA256 1d13ea3a1db5191a16c6d3c22f1ffc9726039301fa9479dda81c61c3c6ad2588
MD5 178f6b02e09a943ae6f6aebacb5d3611
BLAKE2b-256 577635d2465f4b9573418730ab95fe47101d5400946f12df8688296cfc3c065c

See more details on using hashes here.

File details

Details for the file validation_component_bootstrap_utils-0.5.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for validation_component_bootstrap_utils-0.5.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f40f9b5ebdaf64e80bee328251a37539b76e10b5dbd08196cbe621726c0e53de
MD5 d3d59594e6dd89cdda0277e0fc8e7ade
BLAKE2b-256 eb7b8087679760ce6a9a55559932612242a765f30d7fba4b60a43fc831187057

See more details on using hashes here.

Supported by

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