rda-python-dsarch 2.0.18__py3-none-any.whl → 2.0.20__py3-none-any.whl

rda_python_dsarch/dsarch_setup.py

@@ -45,15 +45,15 @@ SETUP_GUIDE = """
  ------------------------------------------------------
 
    # Compile the pywrapper C binary (once per environment):
-   pywrapper-install -u gdexdata
+   pywrapper-install -c|--compile -u|--user gdexdata
 
    # Wire up dsarch as a setuid entry:
-   pywrapper-install -l dsarch -u gdexdata
+   pywrapper-install -l|--link dsarch -u|--user gdexdata
 
  Simple Install (no sudo required, runs as current user)
  -------------------------------------------------------
 
-   pywrapper-install -l dsarch -s
+   pywrapper-install -l|--link dsarch -s|--simple
 
    This creates bin/dsarch -> bin/setuid_dsarch.
    The program runs as the current user with no privilege change.

rda_python_dsarch-2.0.20.dist-info/METADATA

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: rda_python_dsarch
+Version: 2.0.20
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rda_python_common
+Requires-Dist: rda_python_setuid
+Requires-Dist: rda_python_miscs
+Dynamic: license-file
+
+# dsarch
+
+Python project to archive and maintain datasets for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
+
+The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).
+
+## Code overview
+
+The package is built around three Python modules in `src/rda_python_dsarch/`:
+
+- **`dsarch.py`** — Command-line entry point.  Defines `DsArch`, the action
+  class that inherits from `PgArch` and `PgMeta`.  Its two driver methods
+  `read_parameters()` and `start_actions()` parse the CLI and dispatch to
+  the matching handler (archive, get, set, move, delete, restore) for web,
+  saved, help, and Quasar-backup files, plus dataset, group, and version
+  metadata.  After the primary action, it also performs cross-cutting
+  follow-up: dataset period updates, file-count resets (`-WN`/`-WM`/`-RT`),
+  final logging, and optional email notification.
+
+- **`pg_arch.py`** — Shared state and helpers.  Defines the `PgArch` mixin
+  (extends `PgOPT`, `PgCMD`, `PgSplit` from `rda_python_common`).  Holds the
+  master `OPTS` table that maps short action codes (e.g. `AW`, `GD`, `SG`,
+  `RQ`) to their bit flags, names, and write-mode levels; the runtime path
+  cache (`RTPATH`, `webpaths`, `savedpaths`); and group-type/display-order
+  caches.  Provides the utility methods used across all actions: SQL
+  condition building, path resolution, file-name validation, and dataset/
+  group metadata caching.
+
+- **`pg_meta.py`** — File-count bookkeeping and metadata-XML queueing.
+  Defines the `PgMeta` mixin (extends `PgCMD`, `PgSplit`).  Tracks pending
+  changes to per-dataset/per-group file counts in `GCOUNTS` (a 13-slot
+  array covering MSS, web-D/N, and saved buckets) and flushes them to RDADB
+  in batch.  Maintains `META`, a queue of metadata operations dispatched
+  to the external tools `gatherxml`, `dcm`, `rcm`, `scm`, and `sml`.  Also
+  provides `switch_logfile()` for redirecting per-action log/error output.
+
+The inheritance chain is `DsArch -> PgArch -> PgMeta -> PgCMD/PgSplit`, so
+`DsArch` instances expose every option, path, count, and database helper
+through a single object.
+
+## Setuid Setup
+
+`dsarch` is executed as the common user `gdexdata` via the `rda_python_setuid`
+setuid mechanism.  `rda_python_setuid` is declared as a dependency and is
+installed automatically with this package.
+
+### Environment setup
+
+#### Option A — Python venv (DECS machines)
+
+```bash
+python3 -m venv $ENVHOME          # e.g. /glade/u/home/gdexdata/gdexmsenv
+source $ENVHOME/bin/activate
+pip install rda_python_dsarch
+```
+
+#### Option B — Conda (DAV/Casper)
+
+```bash
+conda activate pg-gdex            # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
+pip install rda_python_dsarch
+```
+
+### Full setuid install (requires sudo access to gdexdata)
+
+Run these steps once per environment after `pip install`:
+
+```bash
+# Compile the pywrapper C binary (once per environment):
+pywrapper-install -c|--compile -u|--user gdexdata
+
+# Wire up dsarch as a setuid entry:
+pywrapper-install -l|--link dsarch -u|--user gdexdata
+```
+
+`pywrapper-install` with no arguments displays the full user guide.
+
+### Simple install (no sudo required, runs as current user)
+
+Users who do not need the setuid mechanism can create a direct symlink instead:
+
+```bash
+pywrapper-install -l|--link dsarch -s|--simple
+```
+
+This creates `bin/dsarch -> bin/setuid_dsarch` and the program runs as the
+current user with no privilege change.
+
+### Setup guide
+
+After `pip install`, run `dsarch-setup` at any time to display the setup guide:
+
+```bash
+dsarch-setup
+```
+
+The guide is also shown automatically if `setuid_dsarch` is invoked directly
+before the setuid wrapper has been configured.
+
+## Documentation sync
+
+The user guide rendered 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.

{rda_python_dsarch-2.0.18.dist-info → rda_python_dsarch-2.0.20.dist-info}/RECORD

@@ -4,12 +4,12 @@ rda_python_dsarch/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs
 rda_python_dsarch/ds_arch.py,sha256=6bR0y6_rhIXyvbuYd-oZfL1YcaHhWBkojjzYz1yCrVg,233810
 rda_python_dsarch/dsarch.py,sha256=NEConPE8kIPGoEsmPjBdpeYqZW8p-OKMD1W8rxLO4Io,255368
 rda_python_dsarch/dsarch.usg,sha256=w26gjVm5BYZAX9h_6vHsDvFR6bLVeLFmWa4R7ROd-X4,105687
-rda_python_dsarch/dsarch_setup.py,sha256=LwPjWkFFXugOXl_LlXAbPMvpVFBeM-b46j1wioTFR5g,2070
+rda_python_dsarch/dsarch_setup.py,sha256=9mSdSB_SLNviO07brFqploPJgKqW6nxN4fuyxTWqbLA,2120
 rda_python_dsarch/pg_arch.py,sha256=0mZGlQT9ecJr-92dloXDNtwF8EnPnY76IGLksqYsyYo,81057
 rda_python_dsarch/pg_meta.py,sha256=FFEkphGAT--66zvMNDPfiFG4nZQpXed_yVGMARdZb-o,46981
-rda_python_dsarch-2.0.18.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_dsarch-2.0.18.dist-info/METADATA,sha256=MMGm7r92JPIrWkBVVuso3XzMajtB3qVsUlO9voI4Ytk,2397
-rda_python_dsarch-2.0.18.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_dsarch-2.0.18.dist-info/entry_points.txt,sha256=9P6XioifNVKguvlnW716G1HP0Oloezo6ZWPOa_pVwZQ,115
-rda_python_dsarch-2.0.18.dist-info/top_level.txt,sha256=-vwcMgUXbBdHscvAKB3De9zKac3m_s_FaKIdApP1FGY,18
-rda_python_dsarch-2.0.18.dist-info/RECORD,,
+rda_python_dsarch-2.0.20.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_dsarch-2.0.20.dist-info/METADATA,sha256=xDJaMndeHTnGmvH1AeKtfx9eWxJ8Q08MAo976BwHRmY,4993
+rda_python_dsarch-2.0.20.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_dsarch-2.0.20.dist-info/entry_points.txt,sha256=9P6XioifNVKguvlnW716G1HP0Oloezo6ZWPOa_pVwZQ,115
+rda_python_dsarch-2.0.20.dist-info/top_level.txt,sha256=-vwcMgUXbBdHscvAKB3De9zKac3m_s_FaKIdApP1FGY,18
+rda_python_dsarch-2.0.20.dist-info/RECORD,,

rda_python_dsarch-2.0.18.dist-info/METADATA

@@ -1,82 +0,0 @@
-Metadata-Version: 2.4
-Name: rda_python_dsarch
-Version: 2.0.18
-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
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 5 - Production/Stable
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: rda_python_common
-Requires-Dist: rda_python_setuid
-Requires-Dist: rda_python_miscs
-Dynamic: license-file
-
-# dsarch
-
-Python project to archive and maintain datasets for the [NSF NCAR Geoscience Data Exchange (GDEX)](https://gdex.ucar.edu).
-
-The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).
-
-## Setuid Setup
-
-`dsarch` is executed as the common user `gdexdata` via the `rda_python_setuid`
-setuid mechanism.  `rda_python_setuid` is declared as a dependency and is
-installed automatically with this package.
-
-### Environment setup
-
-#### Option A — Python venv (DECS machines)
-
-```bash
-python3 -m venv $ENVHOME          # e.g. /glade/u/home/gdexdata/gdexmsenv
-source $ENVHOME/bin/activate
-pip install rda_python_dsarch
-```
-
-#### Option B — Conda (DAV/Casper)
-
-```bash
-conda activate pg-gdex            # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
-pip install rda_python_dsarch
-```
-
-### Full setuid install (requires sudo access to gdexdata)
-
-Run these steps once per environment after `pip install`:
-
-```bash
-# Compile the pywrapper C binary (once per environment):
-pywrapper-install -u gdexdata
-
-# Wire up dsarch as a setuid entry:
-pywrapper-install -l dsarch -u gdexdata
-```
-
-`pywrapper-install` with no arguments displays the full user guide.
-
-### Simple install (no sudo required, runs as current user)
-
-Users who do not need the setuid mechanism can create a direct symlink instead:
-
-```bash
-pywrapper-install -l dsarch -s
-```
-
-This creates `bin/dsarch -> bin/setuid_dsarch` and the program runs as the
-current user with no privilege change.
-
-### Setup guide
-
-After `pip install`, run `dsarch-setup` at any time to display the setup guide:
-
-```bash
-dsarch-setup
-```
-
-The guide is also shown automatically if `setuid_dsarch` is invoked directly
-before the setuid wrapper has been configured.