rda-python-dsarch 3.0.0__tar.gz → 3.0.2__tar.gz

{rda_python_dsarch-3.0.0/src/rda_python_dsarch.egg-info → rda_python_dsarch-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 3.0.0
+Version: 3.0.2
 Summary: RDA Python package for utility program dsarch archive RDA data
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-dsarch
@@ -118,6 +118,11 @@ pip install rda_python_dsarch
 in automatically as a dependency.  After `pip install` above, choose one
 of the wiring options below.
 
+> **Note:** If `rda_python_setuid` is already installed and fully set up in
+> your environment, you can skip the compile step (`-c/--compile`) and the
+> optional `pgstart` step (`-p/--pgstart`).  The `-l/--link` step is still
+> required to wire up this package's own setuid program.
+
 ### Full setuid install (requires sudo access to COMMONUSER)
 
 Run these steps once per environment:
@@ -167,12 +172,21 @@ invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 
-The user guide rendered at
+The user guide at
 [gdex-docs-dsarch.readthedocs.io](https://gdex-docs-dsarch.readthedocs.io) is
-generated from `src/rda_python_dsarch/dsarch.usg` in this repository.  When a
-pull request that modifies `dsarch.usg` is merged here, an automated workflow
-converts the updated `dsarch.usg` into the RST-format source files in the
-[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository and
-opens a pull request there with the regenerated docs, ready for review and
-merge.  No manual RST editing is required — keep all user-facing content in
-`dsarch.usg` and let the sync produce the docs.
+generated from `src/rda_python_dsarch/dsarch.usg`.  Keep all user-facing content
+in `dsarch.usg` — no manual RST editing is required.
+
+When a pull request modifying `dsarch.usg` is opened, an automated workflow
+converts it into RST source files and the version number from this repository's
+`pyproject.toml` into the
+[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository, then
+opens a pull request from `automated-update-branch` against its `main` branch for
+review.
+
+To publish to Read the Docs:
+
+- **Merge** that pull request into `main` to serve the content as the `latest`
+  version.
+- **Create a GitHub release** in `gdex-docs-dsarch` to serve the latest release
+  as the `stable` version.

{rda_python_dsarch-3.0.0 → rda_python_dsarch-3.0.2}/README.md

@@ -100,6 +100,11 @@ pip install rda_python_dsarch
 in automatically as a dependency.  After `pip install` above, choose one
 of the wiring options below.
 
+> **Note:** If `rda_python_setuid` is already installed and fully set up in
+> your environment, you can skip the compile step (`-c/--compile`) and the
+> optional `pgstart` step (`-p/--pgstart`).  The `-l/--link` step is still
+> required to wire up this package's own setuid program.
+
 ### Full setuid install (requires sudo access to COMMONUSER)
 
 Run these steps once per environment:
@@ -149,12 +154,21 @@ invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 
-The user guide rendered at
+The user guide at
 [gdex-docs-dsarch.readthedocs.io](https://gdex-docs-dsarch.readthedocs.io) is
-generated from `src/rda_python_dsarch/dsarch.usg` in this repository.  When a
-pull request that modifies `dsarch.usg` is merged here, an automated workflow
-converts the updated `dsarch.usg` into the RST-format source files in the
-[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository and
-opens a pull request there with the regenerated docs, ready for review and
-merge.  No manual RST editing is required — keep all user-facing content in
-`dsarch.usg` and let the sync produce the docs.
+generated from `src/rda_python_dsarch/dsarch.usg`.  Keep all user-facing content
+in `dsarch.usg` — no manual RST editing is required.
+
+When a pull request modifying `dsarch.usg` is opened, an automated workflow
+converts it into RST source files and the version number from this repository's
+`pyproject.toml` into the
+[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository, then
+opens a pull request from `automated-update-branch` against its `main` branch for
+review.
+
+To publish to Read the Docs:
+
+- **Merge** that pull request into `main` to serve the content as the `latest`
+  version.
+- **Create a GitHub release** in `gdex-docs-dsarch` to serve the latest release
+  as the `stable` version.

{rda_python_dsarch-3.0.0 → rda_python_dsarch-3.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rda_python_dsarch"
-version = "3.0.0"
+version = "3.0.2"
 authors = [
   { name="Zaihua Ji", email="zji@ucar.edu" },
 ]

{rda_python_dsarch-3.0.0 → rda_python_dsarch-3.0.2}/src/rda_python_dsarch/dsarch.usg

@@ -11,6 +11,14 @@ reference. Files can be organized into nested sub-products called groups.
 Any metadata stored in GDEXDB can also be retrieved or updated through
 'dsarch'.
 
+By default, 'dsarch' runs as the common user (default 'gdexdata') through
+the rda_python_setuid setuid mechanism, so that data files are archived and
+owned under the common user, and all GDEXDB records are written as the
+common user, regardless of which specialist invokes the command. 'dsarch'
+can also be executed directly as an individual specialist without the
+setuid mechanism, in which case archived files are owned by that
+specialist.
+
 A few terms used throughout this document:
   GDEX       - Geoscience Data Exchange, NCAR's data publication platform
   GDEXDB     - the metadata database backing GDEX
@@ -89,6 +97,16 @@ Only Web data files are placed under DOI/Version control. Saved data
 staged on disk for internal use or NCAR user access is not version-
 controlled and remains the responsibility of the dataset owner.
 
+This user guide is generated from this file. Opening a pull request that
+modifies it in the GitHub repository https://github.com/NCAR/rda-python-dsarch
+triggers an automated workflow that converts it into the RST source files,
+syncs the rda_python_dsarch version into the documentation, and opens a new
+pull request for review in the GitHub repository
+https://github.com/NCAR/gdex-docs-dsarch. Merging that pull request
+publishes the content as the 'latest' version at
+https://gdex-docs-dsarch.readthedocs.io, and creating a GitHub release
+there publishes it as the 'stable' version.
+
 This document first covers general 'dsarch' usage, then describes each
 Action option in detail, followed by Mode and Information (Info for
 short) options. Examples are provided throughout each section.

{rda_python_dsarch-3.0.0 → rda_python_dsarch-3.0.2/src/rda_python_dsarch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 3.0.0
+Version: 3.0.2
 Summary: RDA Python package for utility program dsarch archive RDA data
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-dsarch
@@ -118,6 +118,11 @@ pip install rda_python_dsarch
 in automatically as a dependency.  After `pip install` above, choose one
 of the wiring options below.
 
+> **Note:** If `rda_python_setuid` is already installed and fully set up in
+> your environment, you can skip the compile step (`-c/--compile`) and the
+> optional `pgstart` step (`-p/--pgstart`).  The `-l/--link` step is still
+> required to wire up this package's own setuid program.
+
 ### Full setuid install (requires sudo access to COMMONUSER)
 
 Run these steps once per environment:
@@ -167,12 +172,21 @@ invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 
-The user guide rendered at
+The user guide at
 [gdex-docs-dsarch.readthedocs.io](https://gdex-docs-dsarch.readthedocs.io) is
-generated from `src/rda_python_dsarch/dsarch.usg` in this repository.  When a
-pull request that modifies `dsarch.usg` is merged here, an automated workflow
-converts the updated `dsarch.usg` into the RST-format source files in the
-[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository and
-opens a pull request there with the regenerated docs, ready for review and
-merge.  No manual RST editing is required — keep all user-facing content in
-`dsarch.usg` and let the sync produce the docs.
+generated from `src/rda_python_dsarch/dsarch.usg`.  Keep all user-facing content
+in `dsarch.usg` — no manual RST editing is required.
+
+When a pull request modifying `dsarch.usg` is opened, an automated workflow
+converts it into RST source files and the version number from this repository's
+`pyproject.toml` into the
+[gdex-docs-dsarch](https://github.com/NCAR/gdex-docs-dsarch) repository, then
+opens a pull request from `automated-update-branch` against its `main` branch for
+review.
+
+To publish to Read the Docs:
+
+- **Merge** that pull request into `main` to serve the content as the `latest`
+  version.
+- **Create a GitHub release** in `gdex-docs-dsarch` to serve the latest release
+  as the `stable` version.