rda-python-dsarch 2.0.9__tar.gz → 2.0.12__tar.gz

{rda_python_dsarch-2.0.9 → rda_python_dsarch-2.0.12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 2.0.9
+Version: 2.0.12
 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
@@ -16,3 +16,5 @@ Requires-Dist: rda_python_setuid
 Dynamic: license-file
 
 RDA python Package to archive and maintain RDA datasets.
+
+The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).

rda_python_dsarch-2.0.12/README.md

@@ -0,0 +1,3 @@
+RDA python Package to archive and maintain RDA datasets.
+
+The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).

{rda_python_dsarch-2.0.9 → rda_python_dsarch-2.0.12}/pyproject.toml

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

{rda_python_dsarch-2.0.9 → rda_python_dsarch-2.0.12}/src/rda_python_dsarch/dsarch.usg

@@ -72,8 +72,8 @@ disk for internal use or NCAR user access is not version-controlled and remains
 the responsibility of the dataset owner.
 
 This document first covers general 'dsarch' usage, then describes each Action
-option in detail, followed by Mode and Info options. Examples are provided
-throughout each section.
+option in detail, followed by Mode and Information (Info for short) options.
+Examples are provided throughout each section.
 
 
 2 GENERAL DSARCH USAGE
@@ -84,9 +84,10 @@ throughout each section.
 
 Brackets [] indicate optional elements. A pipe '|' within parentheses, as in
 (A|B), means either A or B may be used. Options fall into three categories:
-  Action options  - specify what task to execute
-  Mode options    - modify how an action behaves
-  Info options    - supply values to the action
+  Action options - specify what task to execute
+  Mode options   - modify how an action behaves
+  Info options   - supply values to the action
+
 Options may be given in short or long form (e.g., -DS or -Dataset). Some
 options have alias names; for example, -UseRDADB is an alias for -UD
 (-UseDSARCH). Option names are case-insensitive,
@@ -111,10 +112,12 @@ is contained within that file.
 Info options used with GET actions serve as query filters. Four special
 characters enable more precise filtering — they must be quoted or escaped
 on the command line to prevent shell interpretation:
-  '!'   (or \!) — exclude matches; must appear immediately after the option name
-  '<'           — less-than comparison on the following value
-  '>'           — greater-than comparison on the following value
-  '<>'          — range between two values
+   '!' - exclude matches; must appear immediately after the option name
+         (may need escaping as '\!' in some shells due to history expansion)
+   '<' - less-than comparison on the following value
+   '>' - greater-than comparison on the following value
+   '<>' - range between two values
+
 Combining '!' and '<' as "'!' '<' OptionValue" expresses a 'greater than or
 equal to OptionValue' condition.
 
@@ -1579,9 +1582,9 @@ IMMA_2.4_2007.tar<:>37<:>IMMA<:>Z.TAR<:>D<:>656820224<:>
   Saved/Web/Help/Quasar file records for a dataset in one step. Equivalent to
   running -SD, -SG, -SS, -SW, -SH, and -SQ together.
 
-  dsarch  -(SA|SetAll) [Mode Options]
-         [-(LN|LoginName) LoginAccountName]
+  dsarch [-(DS|Dataset)] dNNNNNN -(SA|SetAll) [Mode Options]
           -(IF|InputFile) Input Files
+         [-(LN|LoginName) LoginAccountName]
          [-(DB|Debug) DebugModeInfo]
 
   All Mode options applicable to the individual Set actions may be used with
@@ -1760,13 +1763,13 @@ take no values — simply include the flag to activate the behavior.
   'GZ', 'compress' for 'Z', 'zip' for 'ZIP', 'bzip' for 'BZ2'. Files already
   in the target format are skipped. Files compressed in a different format are
   decompressed first (using the tool matched by extension: '.gz', '.Z', '.zip',
-  or '.bz2') before recompressing.
+  or '.bz2') before being recompressed into the target format.
 
 
 5 INFORMATION OPTIONS
 
-Information (Info) options pass data values into 'dsarch'. They come in two
-forms:
+Information (Info for short) options pass data values into 'dsarch'.
+They come in two forms:
   Single-Value Info Options - accept exactly one value per invocation
    Multi-Value Info Options - accept one or more values per invocation
 
@@ -1827,7 +1830,8 @@ forms:
   ascending; lowercase means descending. When file records are modified via
   -AS, -AW, -SS, -SW, -DL, or -MV, files in affected groups are reordered too.
 
-  To reorder an existing file list without other changes, use -SW with -ON:
+  For example, to reorder an existing file list without other changes,
+  use -SW with -ON:
 
   dsarch dNNNNNN -SW -ON OrderNameString [-GI GroupIndices]
 
@@ -1850,6 +1854,7 @@ forms:
     'I' - enabled for internal users only
     'P' - enabled and file lists are published publicly
     'W' - file list publication only
+
   Any value except 'N' must be set before 'dsarch' can write to GDEXDB.
 
   -VS or -ValidSize, the minimum acceptable file size (in bytes) for
@@ -1874,8 +1879,9 @@ forms:
     'Z'   - compressed
     'GZ'  - gzipped
     'BZ2' - bzip2-compressed
+
   Combine values in processing order, e.g., 'C1.TAR.GZ' = COS ASCII blocked,
-  then tarred, then gzipped. Maximum total length is 10 characters.
+  then tarred, then gzipped. Maximum total length is 20 characters.
 
   -BD or -BeginDate, the earliest date covered by the data, for a group,
   the whole dataset, or a version control record.
@@ -1893,7 +1899,7 @@ forms:
   or more host names may follow -BP to target or exclude specific hosts
   (e.g., '-d PBS' to use PBS batch hosts). An optional retry limit (1-99)
   can also be specified, e.g., '-d 5'; defaults to 2. Archive actions
-  (-AS, -AW, -AH, -AQ) retry automatically after storage system outages.
+  (-AS, -AW, -AH, -AQ) retry automatically after storage system outage.
 
   -BS or -BackupStatus, the current Quasar backup state for a file:
     'A' - archived to Quasar (complete)
@@ -1947,7 +1953,7 @@ forms:
   -FF or -FileFlag, specifies whether an entry represents a regular file
   ('F') or a directory path ('P').
 
-  -FS or -FileStatus, the access level of a file: 'P' (public, visible to
+  -FS or -FileStatus, the access level of a file, 'P' (public, visible to
   all users) or 'I' (internal, visible to specialists only).
 
   -FT or -FileTime, the time of day a data file was last modified.
@@ -1970,14 +1976,14 @@ forms:
   -GP or -GroupPattern, wildcard patterns that 'dsarch' uses to automatically
   assign files to the right group during archiving. Stored per group via -SG.
 
-  -GT or -GroupType (Alias: -GroupDataType), the access level for a group:
+  -GT or -GroupType (Alias: -GroupDataType), the access level for a group,
   'P' (public) or 'I' (internal). Changing from P to I recursively marks
   all nested subgroups and their Web files as internal.
 
   -HF or -HelpFile, the destination names for Help files on the GDEX Server.
   Defaults to the local file names from -LF unless overridden explicitly.
 
-  -HT or -HelpFileType (Alias: -HelpType), the category of a Help file:
+  -HT or -HelpFileType (Alias: -HelpType), the category of a Help file,
   'D' (Document) or 'S' (Software). One value applies to all files in the
   batch.
 
@@ -2011,15 +2017,12 @@ forms:
   128 characters.
 
   Set a pair:
-
   dsarch d540000 SD -KV 'test=>test it'
 
   View a specific key:
-
   dsarch d540000 GD -KV test
 
   View all pairs:
-
   dsarch d540000 GD -KV all
 
   -LC or -Location (Alias: -LocationFlag), where the file resides:
@@ -2028,6 +2031,7 @@ forms:
     'O' - Object Store
     'B' - both Glade and Object Store
     'R' - remote URL (Help files only)
+
   At the dataset level (as the online access location), only 'G' or 'O'
   are valid.
 
@@ -2103,6 +2107,7 @@ forms:
     'W' - Work (working/intermediate file)
     'S' - Scratch (temporary file)
     'V' - Version-controlled (locked under DOI)
+
   One value applies to all files in the batch.
 
   -SZ or -Size, the file size in bytes. Measured automatically from local
@@ -2140,7 +2145,7 @@ forms:
   with one subdirectory per subgroup level, mirroring the physical layout.
 
   -WT or -WebFileType (Alias: -WebType|-WebArchiveType), the accessibility of
-  a Web file: 'D' (public data) or 'N' (NCAR internal data only). One value
+  a Web file, 'D' (public data) or 'N' (NCAR internal data only). One value
   applies to all files in the batch.
 
   -WU or -WebURL (Alias: -URL|-WebAddress), the full URL of a Help file

{rda_python_dsarch-2.0.9 → rda_python_dsarch-2.0.12}/src/rda_python_dsarch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_dsarch
-Version: 2.0.9
+Version: 2.0.12
 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
@@ -16,3 +16,5 @@ Requires-Dist: rda_python_setuid
 Dynamic: license-file
 
 RDA python Package to archive and maintain RDA datasets.
+
+The user guide for this utility tool can be viewed at: [User guide](https://gdex-docs-dsarch.readthedocs.io).

rda_python_dsarch-2.0.9/README.md

@@ -1 +0,0 @@
-RDA python Package to archive and maintain RDA datasets.