Metadata-Version: 2.1
Name: pds.deeparchive
Version: 1.1.2
Summary: PDS Deep Archive software for generating OAIS AIPs and SIPs for PDS4 Archives
Home-page: https://github.com/NASA-PDS/pds-deep-archive
Download-URL: https://github.com/NASA-PDS/pds-deep-archive/releases/
Author: PDS
Author-email: pds_operator@jpl.nasa.gov
License: apache-2.0
Keywords: PDS,CCSDS,OAIS,AIP,SIP,metadata,submission,archive,package
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE.md
License-File: NOTICE.txt
Requires-Dist: setuptools
Requires-Dist: lxml (==4.6.3)
Requires-Dist: zope.component (==5.0.1)
Requires-Dist: zope.interface (==5.4.0)
Requires-Dist: pds.api-client (==1.1.0)
Provides-Extra: dev
Requires-Dist: docutils (<=0.16) ; extra == 'dev'
Requires-Dist: sphinx (==4.2.0) ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme (==0.5.0) ; extra == 'dev'
Requires-Dist: sphinx-argparse (==0.2.5) ; extra == 'dev'
Requires-Dist: mypy-zope (==0.3.2) ; extra == 'dev'
Requires-Dist: types-pkg-resources (==0.1.3) ; extra == 'dev'
Requires-Dist: lxml-stubs (==0.2.0) ; extra == 'dev'
Requires-Dist: flake8 (==3.9.2) ; extra == 'dev'
Requires-Dist: flake8-bugbear (==21.9.1) ; extra == 'dev'
Requires-Dist: flake8-docstrings (==1.6.0) ; extra == 'dev'
Requires-Dist: pep8-naming (==0.12.1) ; extra == 'dev'
Requires-Dist: mypy (==0.910) ; extra == 'dev'
Requires-Dist: pydocstyle (==6.1.1) ; extra == 'dev'
Requires-Dist: coverage (==5.5) ; extra == 'dev'
Requires-Dist: pytest (==6.2.5) ; extra == 'dev'
Requires-Dist: pytest-cov (==2.12.1) ; extra == 'dev'
Requires-Dist: pytest-watch (==4.2.0) ; extra == 'dev'
Requires-Dist: pytest-xdist (==2.4.0) ; extra == 'dev'
Requires-Dist: pre-commit (==2.15.0) ; extra == 'dev'

# 🪐 PDS Deep Archive Utilities


[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5750540.svg)](https://doi.org/10.5281/zenodo.5750540) [![Unstable Build](https://github.com/NASA-PDS/pds-deep-archive/workflows/%F0%9F%A4%AA%20Unstable%20integration%20&%20delivery/badge.svg "Latest unstable integration log")](https://github.com/NASA-PDS/pds-deep-archive/actions?query=workflow%3A%22%F0%9F%A4%AA+Unstable+integration+%26+delivery%22) [![Stable Build](https://github.com/NASA-PDS/pds-deep-archive/workflows/%F0%9F%98%8C%20Stable%20integration%20&%20delivery/badge.svg "Latest stable integration log")](https://github.com/NASA-PDS/pds-deep-archive/actions?query=workflow%3A%22%F0%9F%98%8C+Stable+integration+%26+delivery%2)


Software for the [Planetary Data System](https://pds.nasa.gov/) to generate Archive Information Package (AIP) and Submission Information Package (SIP) products, based upon [Open Archival Information System](https://www2.archivists.org/groups/standards-committee/open-archival-information-system-oais) standards.


## ✨ Features

Installing this package will give you two different executable Python programs:

-   `pds-deep-archive` for making Deep Archives of local, on-disk PDS products.
-   `pds-deep-registry-archive` for making Deep Archives of proucts in a PDS Registry server.


## ⎆ Installation

See the online documentation for [Installation](https://nasa-pds.github.io/pds-deep-archive/installation/) instructions.

You should then be able to run the deep archive utilities:

    (pds-deep-archive) bash> pds-deep-archive --help
    (pds-deep-archive) bash> pds-deep-registry-archive --help

👉 _Note:_ The above commands demonstrate typical usage with a command-line prompt, such as that provided by the popular `bash` shell; your own prompt may appear differently and may vary depending on operating system, shell choice, and so forth.


## 👷‍♂️ Build

See the [Development Guide](https://nasa-pds.github.io/pds-deep-archive/development/) for more information.


## 📄 Documentation

Installation and Usage information can be found in the documentation online at https://nasa-pds.github.io/pds-deep-archive/ or the latest version is maintained under the `docs` directory.


### 🐈 Build Sphinx Docs

To build the Sphinx HTML documentation:

```console
$ python3 -m venv venv
$ venv/bin/python setup.py develop
$ venv/bin/python setup.py build_sphinx
running build_sphinx
…
The HTML pages are in build/sphinx/html.
```


## 🥖 Translations

This product has not been translated into any other languages than US English.


## 👏 Contribute

All users and developers of the NASA-PDS software are expected to abide by our [Code of Conduct](https://github.com/NASA-PDS/.github/blob/main/CODE_OF_CONDUCT.md). Please read this to ensure you understand the expectations of our community. For information on how to contribute to NASA-PDS codebases please take a look at our [Contributing guidelines](https://github.com/NASA-PDS/.github/blob/main/CONTRIBUTING.md).

- Issue Tracker: https://github.com/NASA-PDS/pds-deep-archive/issues
- Source Code: https://github.com/NASA-PDS/pds-deep-archive
- Wiki: https://github.com/NASA-PDS/pds-deep-archive/wiki


## 💁‍♀️ Support

If you are having issues file a bug report in Github: https://github.com/NASA-PDS/pds-deep-archive/issues

Or you can reach us at https://pds.nasa.gov/?feedback=true


## 💳 License

The project is licensed under the Apache License, version 2. See the `LICENSE.txt` file for details.
