# 🪐 NASA PDS Registry repository
This repository is an umbrella for the PDS registry application. The application is composed of multiple sub-components, each of them managed in their own repository and integrated here:
- registry-loader: tools to load PDD4 producs to the registry
- opensearch: the famoua data store and search engine which performaces we praise.s
- registry-sweepers: suite of script consolidating the PDS4 product descriptions in OpenSearch.
- registry-api: the PDS Search API service.
- registry-ref-data: some reference datsets that we use for our application integration tests.
Users and administrator should use the documentation published on http://nasa-pds.github.io/registry
This repository specifically contains these PDS registry application resources:
- the source for the user/administrator documentation, see `docs` folder
- docker compose script to start/test the full application with its required components, see https://github.com/NASA-PDS/registry/blob/main/docker/README.md for details. This also includes integration tests (in `docker/postman`). The integration test datasets are maintained in NASA-PDS/registry-ref-data repository.
## Code of Conduct
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.
## Development
To develop this project, use your favorite text editor, or an integrated development environment with Python support, such as [PyCharm](https://www.jetbrains.com/pycharm/).
### Contributing
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).
### Documentation
The project uses [Sphinx](https://www.sphinx-doc.org/en/master/) to build its documentation. PDS' documentation template is already configured as part of the default build. You can build your projects docs with:
cd docs
make html
The generated documnentation can be found in directory docs/build/html
## CI/CD
The template repository comes with our two "standard" CI/CD workflows, `stable-cicd` and `unstable-cicd`. The unstable build runs on any push to `main` (± ignoring changes to specific files) and the stable build runs on push of a release branch of the form `release/<release version>`. Both of these make use of our GitHub actions build step, [Roundup](https://github.com/NASA-PDS/roundup-action). The `unstable-cicd` will generate (and constantly update) a SNAPSHOT release. If you haven't done a formal software release you will end up with a `v0.0.0-SNAPSHOT` release (see NASA-PDS/roundup-action#56 for specifics).
Raw data
{
"_id": null,
"home_page": "https://github.com/NASA-PDS/registry",
"name": "pds.registry",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "pds,planetary data,registry",
"author": "PDS",
"author_email": "pds_operator@jpl.nasa.gov",
"download_url": "https://github.com/NASA-PDS/registry/releases/",
"platform": null,
"description": "\n# \ud83e\ude90 NASA PDS Registry repository\n\nThis repository is an umbrella for the PDS registry application. The application is composed of multiple sub-components, each of them managed in their own repository and integrated here:\n\n- registry-loader: tools to load PDD4 producs to the registry\n- opensearch: the famoua data store and search engine which performaces we praise.s\n- registry-sweepers: suite of script consolidating the PDS4 product descriptions in OpenSearch.\n- registry-api: the PDS Search API service.\n- registry-ref-data: some reference datsets that we use for our application integration tests.\n\n\nUsers and administrator should use the documentation published on http://nasa-pds.github.io/registry\n\nThis repository specifically contains these PDS registry application resources:\n\n- the source for the user/administrator documentation, see `docs` folder\n- docker compose script to start/test the full application with its required components, see https://github.com/NASA-PDS/registry/blob/main/docker/README.md for details. This also includes integration tests (in `docker/postman`). The integration test datasets are maintained in NASA-PDS/registry-ref-data repository.\n\n\n## Code of Conduct\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.\n\n\n## Development\n\nTo develop this project, use your favorite text editor, or an integrated development environment with Python support, such as [PyCharm](https://www.jetbrains.com/pycharm/).\n\n\n### Contributing\n\nFor 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\n\n### Documentation\n\nThe project uses [Sphinx](https://www.sphinx-doc.org/en/master/) to build its documentation. PDS' documentation template is already configured as part of the default build. You can build your projects docs with:\n\n\n cd docs\n make html\n\nThe generated documnentation can be found in directory docs/build/html\n\n\n## CI/CD\n\nThe template repository comes with our two \"standard\" CI/CD workflows, `stable-cicd` and `unstable-cicd`. The unstable build runs on any push to `main` (\u00b1 ignoring changes to specific files) and the stable build runs on push of a release branch of the form `release/<release version>`. Both of these make use of our GitHub actions build step, [Roundup](https://github.com/NASA-PDS/roundup-action). The `unstable-cicd` will generate (and constantly update) a SNAPSHOT release. If you haven't done a formal software release you will end up with a `v0.0.0-SNAPSHOT` release (see NASA-PDS/roundup-action#56 for specifics).\n",
"bugtrack_url": null,
"license": "apache-2.0",
"summary": "A short description, about 100-120 characters, suitable for search summaries",
"version": "1.3.0",
"project_urls": {
"Download": "https://github.com/NASA-PDS/registry/releases/",
"Homepage": "https://github.com/NASA-PDS/registry"
},
"split_keywords": [
"pds",
"planetary data",
"registry"
],
"urls": [
{
"comment_text": "\ud83e\udd20 Yee-haw! This here ar-tee-fact got done uploaded by the Roundup!",
"digests": {
"blake2b_256": "048eec15ad98cd84f47b90e7371802ecf0da99ba794a7e922f408d0061847599",
"md5": "c6a413df9d21a802fb1198da2ab2df94",
"sha256": "238ef6f4e8731229fbcc59cd9d701ce423899d042a66a607791675538402568d"
},
"downloads": -1,
"filename": "pds.registry-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c6a413df9d21a802fb1198da2ab2df94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 10131,
"upload_time": "2023-10-11T18:10:06",
"upload_time_iso_8601": "2023-10-11T18:10:06.471474Z",
"url": "https://files.pythonhosted.org/packages/04/8e/ec15ad98cd84f47b90e7371802ecf0da99ba794a7e922f408d0061847599/pds.registry-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-11 18:10:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NASA-PDS",
"github_project": "registry",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "pds.registry"
}
JSON
