rda-python-common 2.1.8__py3-none-any.whl → 2.1.9__py3-none-any.whl

rda_python_common/__init__.py

@@ -22,7 +22,7 @@ object that existing callers expect.
 
 from . import PgLOG, PgUtil, PgDBI, PgFile, PgLock, PgCMD, PgSIG, PgOPT, PgSplit
 
-__version__ = "2.1.8"
+__version__ = "2.1.9"
 
 __all__ = [
    "PgLOG",

rda_python_common/pgpassword.py

@@ -64,23 +64,29 @@ class PgPassword(PgDBI):
       Parse ``sys.argv`` and apply CLI overrides.
 
       Recognized options:
-         -l URL    -- OpenBao URL (stored in self.PGDBI['BAOURL'])
-         -k TOKEN  -- OpenBao token name (stored in self.PGDBI['BAOTOKEN'])
-         -d NAME   -- PostgreSQL database name
-         -c NAME   -- PostgreSQL schema name
-         -u NAME   -- PostgreSQL login user name
-         -h HOST   -- PostgreSQL server host name
-         -p PORT   -- PostgreSQL port number
+         -? / --help -- show usage and exit
+         -l URL      -- OpenBao URL (stored in self.PGDBI['BAOURL'])
+         -k TOKEN    -- OpenBao token name (stored in self.PGDBI['BAOTOKEN'])
+         -d NAME     -- PostgreSQL database name
+         -c NAME     -- PostgreSQL schema name
+         -u NAME     -- PostgreSQL login user name
+         -h HOST     -- PostgreSQL server host name
+         -p PORT     -- PostgreSQL port number
 
-      If no arguments are supplied a usage message is printed and the
-      process exits with status 0. Unknown options or stray values
-      cause an immediate error exit via ``self.pglog(..., LGEREX)``.
+      With no arguments, all defaults inherited from PgDBI/PgLOG are
+      used and the password lookup proceeds. Unknown options, stray
+      values, or an option without its required value cause an
+      immediate error exit via ``self.pglog(..., LGEREX)``.
       """
       argv = sys.argv[1:]
       opt = None
-      dohelp = True
       for arg in argv:
-         if re.match(r'^-[a-zA-Z]$', arg):
+         if arg in ('-?', '-help', '--help'):
+            self.set_help_path(__file__)
+            self.show_usage("pgpassword")
+         elif re.match(r'^-[a-zA-Z]$', arg):
+            if opt:
+               self.pglog("-" + opt + ": missing option value", self.LGEREX)
             opt = arg[1:]
          elif opt:
             if opt == 'l':
@@ -91,13 +97,12 @@ class PgPassword(PgDBI):
                self.dbopt = True
                self.DBINFO[self.DBFLDS[opt]] = arg
             else:
-               self.pglog(arg + ": Unknown option", self.LGEREX)
-            dohelp = False
+               self.pglog("-" + opt + ": Unknown option", self.LGEREX)
+            opt = None
          else:
-            self.pglog(arg + ": Value provided without option", self.LGEREX)
-      if dohelp:
-         self.set_help_path(__file__)
-         self.show_usage("pgpassword")
+            self.pglog(arg + ": value provided without option", self.LGEREX)
+      if opt:
+         self.pglog("-" + opt + ": missing option value", self.LGEREX)
 
    # get the pgpassword
    def start_actions(self):
@@ -114,7 +119,7 @@ class PgPassword(PgDBI):
       self.password = self.get_baopassword()
       if not self.password: self.password = self.get_pgpassword()
 
-# main function to excecute this script
+# main function to execute this script
 def main():
    """Entry point for the ``pgpassword`` console script: print the retrieved password to stdout."""
    object = PgPassword()

rda_python_common/pgpassword.usg

@@ -0,0 +1,57 @@
+
+ Retrieve a PostgreSQL login password for use by RDA python applications.
+ The password is looked up first from OpenBao (using the URL and token
+ configured in PgDBI) and, if not found there, from the user's .pgpass
+ file.  The retrieved password is printed to stdout so that shell
+ wrappers and other RDA utilities can capture it.
+
+ Usage: pgpassword [-?] [-l OpenBaoURL] [-k TokenName] [-d DBNAME]   \
+                   [-c SCHEMA] [-u USName] [-h DBHOST] [-p DBPORT]
+
+ With no options, pgpassword retrieves the password using all defaults
+ inherited from PgDBI/PgLOG (see per-option defaults below).
+
+      - Option -?, show this usage information and exit (also -help
+          and --help);
+
+      - Option -l, OpenBao URL used to retrieve passwords. Overrides
+          the BAOURL value from the PgDBI configuration.
+          Default: https://bao.k8s.ucar.edu/
+
+      - Option -k, OpenBao token name used to authenticate the password
+          lookup. Overrides the BAOTOKEN value from the PgDBI
+          configuration.
+
+      - Option -d, PostgreSQL database name.
+          Default: rdadb
+
+      - Option -c, PostgreSQL schema name.
+          Default: dssdb
+
+      - Option -u, PostgreSQL login user name.
+          Default: dssdb (same as the -c default)
+
+      - Option -h, PostgreSQL server host name.
+          Default: value of the DSSDBHOST environment variable, or
+          rda-db.ucar.edu if DSSDBHOST is not set.
+
+      - Option -p, PostgreSQL server port number.
+          Default: 5432
+
+ If any of -d, -c, -u, -h, or -p is supplied, the values are applied
+ via default_scinfo() before the password lookup is performed.
+
+ Examples:
+
+   1. Retrieve the password for the default database/user configured
+      in PgDBI:
+
+         pgpassword
+
+   2. Retrieve the password for a specific database, schema and user:
+
+         pgpassword -d rdadb -c dssdb -u metauser
+
+   3. Retrieve the password from a custom OpenBao endpoint:
+
+         pgpassword -l https://bao.example.org -k my-token -d rdadb

{rda_python_common-2.1.8.dist-info → rda_python_common-2.1.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rda_python_common
-Version: 2.1.8
+Version: 2.1.9
 Summary: RDA Python common library codes shared by other RDA python packages
 Author-email: Zaihua Ji <zji@ucar.edu>
 Project-URL: Homepage, https://github.com/NCAR/rda-python-common
@@ -92,7 +92,7 @@ PgLOG.pglog("hello", PgLOG.LOGWRN)
 python -c "import rda_python_common; print(rda_python_common.__version__)"
 ```
 
-You should see the installed version (currently `2.1.8`).  If the import
+You should see the installed version (currently `2.1.9`).  If the import
 fails, double-check that the active Python environment is the one where you
 ran `pip install`.
 

{rda_python_common-2.1.8.dist-info → rda_python_common-2.1.9.dist-info}/RECORD

@@ -7,7 +7,7 @@ rda_python_common/PgOPT.py,sha256=Kn4JYezZhZwAn2usiIYHoHiymGHRgsN299dxyXbKwkI,56
 rda_python_common/PgSIG.py,sha256=eTJJ3XxutsQ3JSg6uYRpH26ZmrVUup3ShqDFLWXLruA,35803
 rda_python_common/PgSplit.py,sha256=SSg5_Qu5PqP44EkqebO-V_cErNcdE2QtORgFHQ7RqlQ,8822
 rda_python_common/PgUtil.py,sha256=OqESKCd72b9g8m8jwjPJhXDtPYlW6G8oSOhwChvz2Cg,48600
-rda_python_common/__init__.py,sha256=6JXEmVcGzKGHOOqOIqeAg_fXqr5PXHlIHiLvwH5D8ac,994
+rda_python_common/__init__.py,sha256=_zWhlp02qZlgMlsox5HGR_mmXRjyQSHIo__v_hTW2rY,994
 rda_python_common/pg_cmd.py,sha256=hQZaW80eFqEUoF0vZHtGuvBEWXbXdY0Nvj6rFIQGboo,32856
 rda_python_common/pg_dbi.py,sha256=q6LT4a4lwo-sM2LEqgrEVkAlh886xeKiz4feqRKw-7c,116238
 rda_python_common/pg_file.py,sha256=RzQTxnht4bFOVty4qoYPREawMCUsnFIbWm2pfEez1fE,161993
@@ -18,10 +18,11 @@ rda_python_common/pg_password.py,sha256=X-eIDwdqBhtrhrbDTNWle-0JtWsyIVZdDOZaBu7c
 rda_python_common/pg_sig.py,sha256=wLKBmFNWAmxWJFC2L3SLsD4n464kzzHbIFFNBlCW6kI,52759
 rda_python_common/pg_split.py,sha256=aAWKUZPmZ-LQ_fJ3DSKzPKxJw0fMDJ2fgP8ZT629M30,16375
 rda_python_common/pg_util.py,sha256=bjp2civRIhqaBSR8oOtyRzYIZBdwB90SzmJLjRIA7fc,87280
-rda_python_common/pgpassword.py,sha256=PVbF_ereAuNf1oy17-KPBycH9-Muy2gWlry9cQIW4sg,4711
-rda_python_common-2.1.8.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
-rda_python_common-2.1.8.dist-info/METADATA,sha256=aiikhrncVk_IyHLmsTwFmjqC0hLD8YELRPszQZHa_f8,11090
-rda_python_common-2.1.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-rda_python_common-2.1.8.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
-rda_python_common-2.1.8.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
-rda_python_common-2.1.8.dist-info/RECORD,,
+rda_python_common/pgpassword.py,sha256=aTQaO59QokWrv2EKom4TvKhNW2Mr6aFMMBVG4DCbcKI,5023
+rda_python_common/pgpassword.usg,sha256=Wrle6A8sdlMGx3ZEAmE6TNDPOlG84Whe0T3rCNFzPfY,2013
+rda_python_common-2.1.9.dist-info/licenses/LICENSE,sha256=1dck4EAQwv8QweDWCXDx-4Or0S8YwiCstaso_H57Pno,1097
+rda_python_common-2.1.9.dist-info/METADATA,sha256=RCXhbSP_OnuQyIUUa5h67nFYjzElGU2uDBMXoH5wFcY,11090
+rda_python_common-2.1.9.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+rda_python_common-2.1.9.dist-info/entry_points.txt,sha256=pZgVNWspcK-F1TbPav7C3C9NdeHDZMm_25fW9weix00,65
+rda_python_common-2.1.9.dist-info/top_level.txt,sha256=KVQmx7D3DD-jsiheqL8HdTrRE14hpRnZY5_ioMArA5k,18
+rda_python_common-2.1.9.dist-info/RECORD,,