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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 2.0.20
+Version: 3.0.0
 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
@@ -56,39 +56,85 @@ 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
 
-### Environment setup
+Create a Python environment first; package installs in the next section run
+inside whichever environment you activate here.
 
-#### Option A — Python venv (DECS machines)
+### 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)
+### Option B — Conda (DAV/Casper)
 
 ```bash
-conda activate pg-gdex            # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
-pip install rda_python_dsarch
+conda create --prefix $ENVHOME python=3.12   # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
+conda activate $ENVHOME
+```
+
+## Installing rda-python-dsarch
+
+Pick whichever install mode fits your workflow.  All four pull in the
+transitive dependencies (`rda_python_common`, `rda_python_setuid`,
+`rda_python_miscs`) automatically.
+
+For local development, clone this repo alongside your project and install it
+in editable mode so that changes are picked up without re-installing:
+
+```bash
+git clone https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
+```
+
+To test a specific branch (e.g. an in-progress feature or fix branch), pass
+`-b/--branch` to `git clone`:
+
+```bash
+git clone -b <branch-name> https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
 ```
 
-### Full setuid install (requires sudo access to gdexdata)
+For a regular (non-editable) install from a checkout:
 
-Run these steps once per environment after `pip install`:
+```bash
+pip install /path/to/rda-python-dsarch
+```
+
+For a production install on a system that uses the published distribution:
 
 ```bash
-# Compile the pywrapper C binary (once per environment):
-pywrapper-install -c|--compile -u|--user gdexdata
+pip install rda_python_dsarch
+```
+
+## Setuid Setup
 
-# Wire up dsarch as a setuid entry:
-pywrapper-install -l|--link dsarch -u|--user gdexdata
+`dsarch` is executed as the common user `PGLOG['COMMONUSER']` (default
+`gdexdata`) via the `rda_python_setuid` setuid mechanism, which is pulled
+in automatically as a dependency.  After `pip install` above, choose one
+of the wiring options below.
+
+### Full setuid install (requires sudo access to COMMONUSER)
+
+Run these steps once per environment:
+
+```bash
+# 1. Compile the pywrapper C binary (once per environment):
+pywrapper-install -c|--compile -n|--username gdexdata
+
+# 2. Wire up dsarch as a setuid entry (or use 'all' to link every setuid_* at once):
+pywrapper-install -l|--link dsarch
+pywrapper-install -l|--link all
+
+# 3. Optionally, install a pgstart_<loginname> binary so <loginname> (any
+#    user in the same group as PGLOG['COMMONUSER']) can run commands as
+#    themselves.  Run either by PGLOG['ADMINUSER'] (default zji, if it has
+#    'sudo -u <loginname>'), or by <loginname> directly:
+pywrapper-install -p|--pgstart -n|--username <loginname>
 ```
 
 `pywrapper-install` with no arguments displays the full user guide.
@@ -99,21 +145,25 @@ Users who do not need the setuid mechanism can create a direct symlink instead:
 
 ```bash
 pywrapper-install -l|--link dsarch -s|--simple
+pywrapper-install -l|--link all -s|--simple   # or link every setuid_* at once
 ```
 
 This creates `bin/dsarch -> bin/setuid_dsarch` and the program runs as the
 current user with no privilege change.
 
-### Setup guide
+### Update an existing installation (no sudo required)
 
-After `pip install`, run `dsarch-setup` at any time to display the setup guide:
+When the package is upgraded and a new `pywrapper.c` is bundled, recompile and
+reinstall all setuid binaries using the existing `pgstart_*` binaries:
 
 ```bash
-dsarch-setup
+pywrapper-install -u|--update
 ```
 
-The guide is also shown automatically if `setuid_dsarch` is invoked directly
-before the setuid wrapper has been configured.
+### Setup guide
+
+The shared setuid setup guide is shown automatically if `setuid_dsarch` is
+invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 

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

@@ -38,39 +38,85 @@ 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
 
-### Environment setup
+Create a Python environment first; package installs in the next section run
+inside whichever environment you activate here.
 
-#### Option A — Python venv (DECS machines)
+### 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)
+### Option B — Conda (DAV/Casper)
 
 ```bash
-conda activate pg-gdex            # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
-pip install rda_python_dsarch
+conda create --prefix $ENVHOME python=3.12   # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
+conda activate $ENVHOME
+```
+
+## Installing rda-python-dsarch
+
+Pick whichever install mode fits your workflow.  All four pull in the
+transitive dependencies (`rda_python_common`, `rda_python_setuid`,
+`rda_python_miscs`) automatically.
+
+For local development, clone this repo alongside your project and install it
+in editable mode so that changes are picked up without re-installing:
+
+```bash
+git clone https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
+```
+
+To test a specific branch (e.g. an in-progress feature or fix branch), pass
+`-b/--branch` to `git clone`:
+
+```bash
+git clone -b <branch-name> https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
 ```
 
-### Full setuid install (requires sudo access to gdexdata)
+For a regular (non-editable) install from a checkout:
 
-Run these steps once per environment after `pip install`:
+```bash
+pip install /path/to/rda-python-dsarch
+```
+
+For a production install on a system that uses the published distribution:
 
 ```bash
-# Compile the pywrapper C binary (once per environment):
-pywrapper-install -c|--compile -u|--user gdexdata
+pip install rda_python_dsarch
+```
+
+## Setuid Setup
 
-# Wire up dsarch as a setuid entry:
-pywrapper-install -l|--link dsarch -u|--user gdexdata
+`dsarch` is executed as the common user `PGLOG['COMMONUSER']` (default
+`gdexdata`) via the `rda_python_setuid` setuid mechanism, which is pulled
+in automatically as a dependency.  After `pip install` above, choose one
+of the wiring options below.
+
+### Full setuid install (requires sudo access to COMMONUSER)
+
+Run these steps once per environment:
+
+```bash
+# 1. Compile the pywrapper C binary (once per environment):
+pywrapper-install -c|--compile -n|--username gdexdata
+
+# 2. Wire up dsarch as a setuid entry (or use 'all' to link every setuid_* at once):
+pywrapper-install -l|--link dsarch
+pywrapper-install -l|--link all
+
+# 3. Optionally, install a pgstart_<loginname> binary so <loginname> (any
+#    user in the same group as PGLOG['COMMONUSER']) can run commands as
+#    themselves.  Run either by PGLOG['ADMINUSER'] (default zji, if it has
+#    'sudo -u <loginname>'), or by <loginname> directly:
+pywrapper-install -p|--pgstart -n|--username <loginname>
 ```
 
 `pywrapper-install` with no arguments displays the full user guide.
@@ -81,21 +127,25 @@ Users who do not need the setuid mechanism can create a direct symlink instead:
 
 ```bash
 pywrapper-install -l|--link dsarch -s|--simple
+pywrapper-install -l|--link all -s|--simple   # or link every setuid_* at once
 ```
 
 This creates `bin/dsarch -> bin/setuid_dsarch` and the program runs as the
 current user with no privilege change.
 
-### Setup guide
+### Update an existing installation (no sudo required)
 
-After `pip install`, run `dsarch-setup` at any time to display the setup guide:
+When the package is upgraded and a new `pywrapper.c` is bundled, recompile and
+reinstall all setuid binaries using the existing `pgstart_*` binaries:
 
 ```bash
-dsarch-setup
+pywrapper-install -u|--update
 ```
 
-The guide is also shown automatically if `setuid_dsarch` is invoked directly
-before the setuid wrapper has been configured.
+### Setup guide
+
+The shared setuid setup guide is shown automatically if `setuid_dsarch` is
+invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "rda_python_dsarch"
-version = "2.0.20"
+version = "3.0.0"
 authors = [
   { name="Zaihua Ji", email="zji@ucar.edu" },
 ]
@@ -33,4 +33,3 @@ pythonpath = [
 
 [project.scripts]
 "setuid_dsarch" = "rda_python_dsarch.dsarch:main"
-"dsarch-setup" = "rda_python_dsarch.dsarch_setup:main"

rda_python_dsarch-3.0.0/src/rda_python_dsarch/__init__.py

@@ -0,0 +1,29 @@
+"""rda_python_dsarch: dataset archive (dsarch) utility package.
+
+This package exposes two parallel APIs:
+
+1. Legacy module-based API (back-compat). Import the capitalized
+   submodules and call their module-level functions, e.g.::
+
+       from rda_python_dsarch import PgArch, PgMeta
+
+2. Class-based API (preferred for new code). Import the class from the
+   lower-case module and either instantiate or subclass it, e.g.::
+
+       from rda_python_dsarch.pg_arch import PgArch
+       from rda_python_dsarch.pg_meta import PgMeta
+
+The legacy submodules are eagerly imported below so that
+``from rda_python_dsarch import PgArch`` continues to return the module
+object that existing callers expect.
+"""
+
+from . import PgArch, PgMeta
+
+__version__ = "2.0.21"
+
+__all__ = [
+   "PgArch",
+   "PgMeta",
+   "__version__",
+]

{rda_python_dsarch-2.0.20 → rda_python_dsarch-3.0.0}/src/rda_python_dsarch/dsarch.py

@@ -3204,7 +3204,6 @@ class DsArch(PgArch, PgMeta):
       tmpds = tmpgs = None
       bidx = chksize = 0
       bucket = self.PGLOG['OBJCTBKT']
-      rcnt = len(self.PGLOG['WEBHOSTS'])
       s = 's' if self.ALLCNT > 1 else ''
       if 'OD' not in self.params:
          self.params['OD'] = dsid
@@ -3353,7 +3352,6 @@ class DsArch(PgArch, PgMeta):
       tmpds = None
       bidx = chksize = 0
       bucket = self.PGLOG['OBJCTBKT']
-      rcnt = len(self.PGLOG['WEBHOSTS'])
       s = 's' if self.ALLCNT > 1 else ''
       if 'OD' not in self.params:
          self.params['OD'] = dsid
@@ -3632,7 +3630,6 @@ class DsArch(PgArch, PgMeta):
       bucket = self.PGLOG['OBJCTBKT']
       s = 's' if self.ALLCNT > 1 else ''
       bidx = chksize = 0
-      rcnt = len(self.PGLOG['WEBHOSTS'])
       self.pglog("Delete {} Web file{} from {} ...".format(self.ALLCNT, s, dsid), self.WARNLG)
       reorder = metatotal = metacnt = dcnt = mcnt = ocnt = wcnt = 0
       self.cache_group_info(self.ALLCNT, 0)
@@ -3741,7 +3738,6 @@ class DsArch(PgArch, PgMeta):
       dcnd = "dsid = '{}'".format(dsid)
       s = 's' if self.ALLCNT > 1 else ''
       bidx = chksize = 0
-      rcnt = len(self.PGLOG['WEBHOSTS'])
       self.pglog("Delete {} Help file{} from {} ...".format(self.ALLCNT, s, dsid), self.WARNLG)
       reorder = dcnt = hcnt = ocnt = mcnt = 0
       self.cache_group_info(self.ALLCNT, 0)
@@ -3787,9 +3783,7 @@ class DsArch(PgArch, PgMeta):
             if pgrec['url']:
                fcnt = 1
             else:
-               fcnt = 0
-               for j in range(rcnt):
-                  fcnt += self.delete_local_file(afile, self.PGOPT['emerol'])
+               fcnt = self.delete_local_file(afile, self.PGOPT['emerol'])
             if fcnt:
                hcnt += 1
                hflag = 0
@@ -4957,11 +4951,9 @@ def main():
    Instantiates DsArch, parses arguments via read_parameters(), executes the
    requested action via start_actions(), and exits cleanly.
    """
-   import sys
-   if os.path.basename(sys.argv[0]) == 'setuid_dsarch':
-      from rda_python_dsarch.dsarch_setup import main as setup_main
-      setup_main()
+   from rda_python_setuid.setup_guide import show_setup_guide
    object = DsArch()
+   show_setup_guide(object, 'rda_python_dsarch', ['dsarch'])
    object.read_parameters()
    object.start_actions()
    object.pgexit(0)

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 2.0.20
+Version: 3.0.0
 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
@@ -56,39 +56,85 @@ 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
 
-### Environment setup
+Create a Python environment first; package installs in the next section run
+inside whichever environment you activate here.
 
-#### Option A — Python venv (DECS machines)
+### 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)
+### Option B — Conda (DAV/Casper)
 
 ```bash
-conda activate pg-gdex            # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
-pip install rda_python_dsarch
+conda create --prefix $ENVHOME python=3.12   # e.g. /glade/work/gdexdata/conda-envs/pg-gdex
+conda activate $ENVHOME
+```
+
+## Installing rda-python-dsarch
+
+Pick whichever install mode fits your workflow.  All four pull in the
+transitive dependencies (`rda_python_common`, `rda_python_setuid`,
+`rda_python_miscs`) automatically.
+
+For local development, clone this repo alongside your project and install it
+in editable mode so that changes are picked up without re-installing:
+
+```bash
+git clone https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
+```
+
+To test a specific branch (e.g. an in-progress feature or fix branch), pass
+`-b/--branch` to `git clone`:
+
+```bash
+git clone -b <branch-name> https://github.com/NCAR/rda-python-dsarch.git
+cd rda-python-dsarch
+pip install -e .
 ```
 
-### Full setuid install (requires sudo access to gdexdata)
+For a regular (non-editable) install from a checkout:
 
-Run these steps once per environment after `pip install`:
+```bash
+pip install /path/to/rda-python-dsarch
+```
+
+For a production install on a system that uses the published distribution:
 
 ```bash
-# Compile the pywrapper C binary (once per environment):
-pywrapper-install -c|--compile -u|--user gdexdata
+pip install rda_python_dsarch
+```
+
+## Setuid Setup
 
-# Wire up dsarch as a setuid entry:
-pywrapper-install -l|--link dsarch -u|--user gdexdata
+`dsarch` is executed as the common user `PGLOG['COMMONUSER']` (default
+`gdexdata`) via the `rda_python_setuid` setuid mechanism, which is pulled
+in automatically as a dependency.  After `pip install` above, choose one
+of the wiring options below.
+
+### Full setuid install (requires sudo access to COMMONUSER)
+
+Run these steps once per environment:
+
+```bash
+# 1. Compile the pywrapper C binary (once per environment):
+pywrapper-install -c|--compile -n|--username gdexdata
+
+# 2. Wire up dsarch as a setuid entry (or use 'all' to link every setuid_* at once):
+pywrapper-install -l|--link dsarch
+pywrapper-install -l|--link all
+
+# 3. Optionally, install a pgstart_<loginname> binary so <loginname> (any
+#    user in the same group as PGLOG['COMMONUSER']) can run commands as
+#    themselves.  Run either by PGLOG['ADMINUSER'] (default zji, if it has
+#    'sudo -u <loginname>'), or by <loginname> directly:
+pywrapper-install -p|--pgstart -n|--username <loginname>
 ```
 
 `pywrapper-install` with no arguments displays the full user guide.
@@ -99,21 +145,25 @@ Users who do not need the setuid mechanism can create a direct symlink instead:
 
 ```bash
 pywrapper-install -l|--link dsarch -s|--simple
+pywrapper-install -l|--link all -s|--simple   # or link every setuid_* at once
 ```
 
 This creates `bin/dsarch -> bin/setuid_dsarch` and the program runs as the
 current user with no privilege change.
 
-### Setup guide
+### Update an existing installation (no sudo required)
 
-After `pip install`, run `dsarch-setup` at any time to display the setup guide:
+When the package is upgraded and a new `pywrapper.c` is bundled, recompile and
+reinstall all setuid binaries using the existing `pgstart_*` binaries:
 
 ```bash
-dsarch-setup
+pywrapper-install -u|--update
 ```
 
-The guide is also shown automatically if `setuid_dsarch` is invoked directly
-before the setuid wrapper has been configured.
+### Setup guide
+
+The shared setuid setup guide is shown automatically if `setuid_dsarch` is
+invoked directly before the setuid wrapper has been configured.
 
 ## Documentation sync
 

{rda_python_dsarch-2.0.20 → rda_python_dsarch-3.0.0}/src/rda_python_dsarch.egg-info/SOURCES.txt

@@ -8,7 +8,6 @@ src/rda_python_dsarch/__init__.py
 src/rda_python_dsarch/ds_arch.py
 src/rda_python_dsarch/dsarch.py
 src/rda_python_dsarch/dsarch.usg
-src/rda_python_dsarch/dsarch_setup.py
 src/rda_python_dsarch/pg_arch.py
 src/rda_python_dsarch/pg_meta.py
 src/rda_python_dsarch.egg-info/PKG-INFO

{rda_python_dsarch-2.0.20 → rda_python_dsarch-3.0.0}/src/rda_python_dsarch.egg-info/entry_points.txt

@@ -1,3 +1,2 @@
 [console_scripts]
-dsarch-setup = rda_python_dsarch.dsarch_setup:main
 setuid_dsarch = rda_python_dsarch.dsarch:main

rda_python_dsarch-2.0.20/src/rda_python_dsarch/__init__.py

@@ -1 +0,0 @@
-

rda_python_dsarch-2.0.20/src/rda_python_dsarch/dsarch_setup.py

@@ -1,69 +0,0 @@
-#!/usr/bin/env python3
-#
-##################################################################################
-#
-#     Title: dsarch-setup
-#    Author: Zaihua Ji, zji@ucar.edu
-#      Date: 2026-05-12
-#   Purpose: Display the setuid setup guide for dsarch after pip install.
-#            Run automatically when setuid_dsarch is invoked directly instead
-#            of through the dsarch -> pywrapper setuid symlink.
-#
-#    Github: https://github.com/NCAR/rda-python-dsarch.git
-#
-##################################################################################
-
-import os
-import sys
-
-
-SETUP_GUIDE = """
- dsarch - Setuid Setup Guide
- ===========================
-
- dsarch must be run as the common user 'gdexdata' via the rda_python_setuid
- mechanism.  rda_python_setuid is installed automatically as a dependency.
-
- If you are seeing this message after running 'setuid_dsarch' directly, it
- means the setuid wrapper has not been set up yet.  Follow the steps below.
-
- Run 'pywrapper-install' with no arguments for the full pywrapper user guide.
-
- Environment Setup
- -----------------
-
-   Option A - Python venv (DECS machines):
-      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):
-      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)
- ------------------------------------------------------
-
-   # 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
-
- Simple Install (no sudo required, runs as current user)
- -------------------------------------------------------
-
-   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.
-
-"""
-
-
-def main():
-   print(SETUP_GUIDE)
-   sys.exit(0)
-
-
-if __name__ == '__main__': main()