PDS Deep Archive software for generating OAIS AIPs and SIPs for PDS4 Archives
Project description
🪐 PDS Deep Archive Utilities
Software for the Planetary Data System to generate Archive Information Package (AIP) and Submission Information Package (SIP) products, based upon Open Archival Information System 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 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 for more information.
📄 Documentation
Installation and Usage information can be found in the documentation online at https://nasa-pds.github.io/deep-archive/ or the latest version is maintained under the docs
directory.
🐈 Build Sphinx Docs
To build the Sphinx HTML documentation:
$ python3.9 -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. 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.
- Issue Tracker: https://github.com/NASA-PDS/deep-archive/issues
- Source Code: https://github.com/NASA-PDS/deep-archive
- Wiki: https://github.com/NASA-PDS/deep-archive/wiki
💽 Getting Test Data
If you need to mirror a part of a website to add to the test data, try this handy invocation of wget
:
$ wget \
--quiet \
--execute robots=off \
--cut-dirs=2 \
--reject='index.html*' \
--no-host-directories \
--mirror \
--no-parent \
--relative \
--timestamping \
--no-check-certificate \
--recursive \
"https://whatever/some/path"
Note ⑴: Although the author typically reaches for curl
, it lacks a direct mirroring option—hence wget
here.
Note ⑵: This is mostly a "note-to-self" for the author of this subsection 😉.
💁♀️ Support
If you are having issues file a bug report in Github: https://github.com/NASA-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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for pds.deeparchive-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfb3f00d6a4cebe47f4f3f5dc6425299d48be1e99044989082a66185af9766d6 |
|
MD5 | d7716d28bb63be97f928713db0530ea5 |
|
BLAKE2b-256 | d83be548b5298f30f25d26b4f24f82ed01f601bfb862b2967e815e3457fe19a4 |