# 🪐 PDS Deep Archive Utilities
[](https://doi.org/10.5281/zenodo.5750540) [](https://github.com/NASA-PDS/deep-archive/actions?query=workflow%3A%22%F0%9F%A4%AA+Unstable+integration+%26+delivery%22) [](https://github.com/NASA-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/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/deep-archive/development/index.html) 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:
```console
$ 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](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/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`:
```console
$ 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/NASA-PDS/deep-archive",
"name": "pds.deeparchive",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "PDS, CCSDS, OAIS, AIP, SIP, metadata, submission, archive, package",
"author": "PDS",
"author_email": "pds_operator@jpl.nasa.gov",
"download_url": "https://github.com/NASA-PDS/deep-archive/releases/",
"platform": null,
"description": "# \ud83e\ude90 PDS Deep Archive Utilities\n\n\n[](https://doi.org/10.5281/zenodo.5750540) [![Unstable Build](https://github.com/NASA-PDS/deep-archive/workflows/%F0%9F%A4%AA%20Unstable%20integration%20&%20delivery/badge.svg \"Latest unstable integration log\")](https://github.com/NASA-PDS/deep-archive/actions?query=workflow%3A%22%F0%9F%A4%AA+Unstable+integration+%26+delivery%22) [![Stable Build](https://github.com/NASA-PDS/deep-archive/workflows/%F0%9F%98%8C%20Stable%20integration%20&%20delivery/badge.svg \"Latest stable integration log\")](https://github.com/NASA-PDS/deep-archive/actions?query=workflow%3A%22%F0%9F%98%8C+Stable+integration+%26+delivery%2)\n\n\nSoftware 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.\n\n\n## \u2728 Features\n\nInstalling this package will give you two different executable Python programs:\n\n- `pds-deep-archive` for making Deep Archives of local, on-disk PDS products.\n- `pds-deep-registry-archive` for making Deep Archives of proucts in a PDS Registry server.\n\n\n## \u2386 Installation\n\nSee the online documentation for [Installation](https://nasa-pds.github.io/deep-archive/installation/) instructions.\n\nYou should then be able to run the deep archive utilities:\n\n (pds-deep-archive) bash> pds-deep-archive --help\n (pds-deep-archive) bash> pds-deep-registry-archive --help\n\n\ud83d\udc49 _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.\n\n\n## \ud83d\udc77\u200d\u2642\ufe0f Build\n\nSee the [Development Guide](https://nasa-pds.github.io/deep-archive/development/index.html) for more information.\n\n\n## \ud83d\udcc4 Documentation\n\nInstallation 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.\n\n\n### \ud83d\udc08 Build Sphinx Docs\n\nTo build the Sphinx HTML documentation:\n\n```console\n$ python3.9 -m venv venv\n$ venv/bin/python setup.py develop\n$ venv/bin/python setup.py build_sphinx\nrunning build_sphinx\n\u2026\nThe HTML pages are in build/sphinx/html.\n```\n\n\n## \ud83e\udd56 Translations\n\nThis product has not been translated into any other languages than US English.\n\n\n## \ud83d\udc4f Contribute\n\nAll 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).\n\n- Issue Tracker: https://github.com/NASA-PDS/deep-archive/issues\n- Source Code: https://github.com/NASA-PDS/deep-archive\n- Wiki: https://github.com/NASA-PDS/deep-archive/wiki\n\n\n### \ud83d\udcbd Getting Test Data\n\nIf you need to mirror a part of a website to add to the test data, try this handy invocation of `wget`:\n```console\n$ wget \\\n --quiet \\\n --execute robots=off \\\n --cut-dirs=2 \\\n --reject='index.html*' \\\n --no-host-directories \\\n --mirror \\\n --no-parent \\\n --relative \\\n --timestamping \\\n --no-check-certificate \\\n --recursive \\\n \"https://whatever/some/path\"\n```\nNote \u2474: Although the author typically reaches for `curl`, it lacks a direct mirroring option\u2014hence `wget` here.\n\nNote \u2475: This is mostly a \"note-to-self\" for the author of this subsection \ud83d\ude09.\n\n\n## \ud83d\udc81\u200d\u2640\ufe0f Support\n\nIf you are having issues file a bug report in Github: https://github.com/NASA-PDS/deep-archive/issues\n\nOr you can reach us at https://pds.nasa.gov/?feedback=true\n\n\n## \ud83d\udcb3 License\n\nThe project is licensed under the Apache License, version 2. See the `LICENSE.txt` file for details.\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "PDS Deep Archive software for generating OAIS AIPs and SIPs for PDS4 Archives",
"version": "1.3.0",
"project_urls": {
"Download": "https://github.com/NASA-PDS/deep-archive/releases/",
"Homepage": "https://github.com/NASA-PDS/deep-archive"
},
"split_keywords": [
"pds",
" ccsds",
" oais",
" aip",
" sip",
" metadata",
" submission",
" archive",
" package"
],
"urls": [
{
"comment_text": "\ud83e\udd20 Yee-haw! This here ar-tee-fact got done uploaded by the Roundup!",
"digests": {
"blake2b_256": "d83be548b5298f30f25d26b4f24f82ed01f601bfb862b2967e815e3457fe19a4",
"md5": "d7716d28bb63be97f928713db0530ea5",
"sha256": "dfb3f00d6a4cebe47f4f3f5dc6425299d48be1e99044989082a66185af9766d6"
},
"downloads": -1,
"filename": "pds.deeparchive-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d7716d28bb63be97f928713db0530ea5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 45413,
"upload_time": "2024-10-16T22:41:15",
"upload_time_iso_8601": "2024-10-16T22:41:15.430066Z",
"url": "https://files.pythonhosted.org/packages/d8/3b/e548b5298f30f25d26b4f24f82ed01f601bfb862b2967e815e3457fe19a4/pds.deeparchive-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-16 22:41:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NASA-PDS",
"github_project": "deep-archive",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pds.deeparchive"
}
JSON
