mast_contributor_tools Documentation

GETTING STARTED

• MAST CONTRIBUTOR TOOLS
  • Development Workflow
  • Installation
    • Required packages and versions
    • Conda environment
    • mast_contributor_tools
    • (Optional for Development) VSCode settings.json
  • pre-commit for development
    • Install pre-commit
    • Testing
    • Sphinx documentation set up
  • Quick Start
    • Tutorials
    • Filename Check
    • Metadata Checker
• License
• Contributing
• Additional Resources
• Changelog
  • [Unreleased]
    • Added
    • Changed
    • Deprecated
    • Fixed
    • Removed
    • Security
  • 1.0.1 (2025-11-10)
    • Fixed
  • 1.0.0 (2025-10-08)
    • Added
    • Changed
    • Deprecated
    • Fixed
    • Removed
    • Security

File Name Checker

• Filename Check
  • Calling sequence
    • Example Usage: Check all files in the current directory
    • Example Usage: Check all files matching a pattern in a specified directory
    • Example Usage: Check all files supplied in a file list
    • Example Usage: Test a single filename
    • Resources
  • Filename components
  • Filename evaluation
  • Reading the Results

Packages and Modules

• Command-Line Tool
  • Quick Reference
    • mast_contributor_tools
  • Complete Reference
    • mast_contributor_tools
• mast_contributor_tools
  • mast_contributor_tools package
    • Subpackages
    • Submodules
    • mast_contributor_tools.mast_cli module
    • Module contents

Tutorials

• MAST Contributor Tools Tutorial
  • Installation
• TUTORIAL 1: Filename Checker
  • Introduction
  • Step 1: Investigating the Tutorial data.
  • Step 2: Use the –help command to learn about the options
  • Step 3: Check an Individual File Name
    • Step 3a: An example file name which passes
    • Step 3b: An example file name which fails
  • Step 4: Checking multiple file names at once
    • Step 4a: Check multiple file names in one command
    • Step 4b: Check all file names in a directory
    • Step 4c: Check all file names from a list
    • Step 4d. Selecting or Excluding files
    • Step 4e. Exporting results to alternate format
• Additional Resources
• Reading the File Name Checker Results: Tutorial for SQLite files
  • Reading and Interacting with SQLite files
    • View with the DB Browser for SQLite
    • Opening the SQLite file with Python

• Index

• Module Index

• Search Page