Metadata-Version: 2.4
Name: mast_transfer_tools
Version: 1.0.0
Summary: Upload data sets to MAST using the new FAST protocol
Author-email: "Michael St. Clair" <mstclair@millionconcepts.com>, Zack Weinberg <zack@millionconcepts.com>
License-Expression: BSD-3-Clause
Project-URL: Repository, https://github.com/MillionConcepts/fast-upload
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Environment :: No Input/Output (Daemon)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: System :: Archiving
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: asdf
Requires-Dist: asdf-astropy
Requires-Dist: astropy
Requires-Dist: click
Requires-Dist: hostess[aws]
Requires-Dist: pyarrow
Requires-Dist: s3fs
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: hypothesis; extra == "tests"
Provides-Extra: typecheck
Requires-Dist: mypy; extra == "typecheck"
Requires-Dist: pandas-stubs; extra == "typecheck"
Requires-Dist: pyarrow-stubs; extra == "typecheck"
Requires-Dist: types-PyYAML; extra == "typecheck"
Requires-Dist: types-python-dateutil; extra == "typecheck"
Dynamic: license-file

# Upload data sets to MAST using the new FAST protocol

This repository contains the `mast-upload` tool for uploading data
sets to [MAST][], the Barbara A. Mikulski Archive for Space Telescopes,
along with assorted support code.

It also contains the software for the data ingestion and validation
server that `mast-upload` interacts with. If you are not administrative 
staff at MAST itself, you will probably not have any use for this.

## Installation

This package will be installable from PyPi in the near future. At present,
install from source: clone the repo to your computer, create a virtual 
environment if you wish, and run `pip install .` from repo root. Python >= 
3.11 is required.

## Usage

The primary interface is the `mast-upload` command. Detailed help for it and 
its subcommands are available with `mast-upload --help` and 
`mast-upload <subcommand> --help`.

[basic_usage.md](/docs/basic_usage.md) includes step-by-step instructions for a 
standard dataset submission workflow.

## Documentation

Additional documentation, including an API reference, is available at 
https://fast-upload.readthedocs.io/en/latest/.

## Tests

You can execute the self-tests by running `pytest` from repo root 
(note that the tests additionally depend on `pytest` and `hypothesis`).

[MAST]: https://archive.stsci.edu/
