Spell out the script name; people are gonna run this, like, once; also various text tweaks and doc fixes

Author: matyasselmeci

README.md

@@ -477,30 +477,30 @@ This section is contained in `/etc/osg/config.d/40-siteinfo.ini` which is provid
 | **resource\_group** | String            | The resource\_group of this CE as registered in Topology.                                                                                         |
 
 
-OSG Resource Catalog Generator
-==============================
+OSG CE Attributes Generator
+===========================
 
-The Resource Catalog Generator is a standalone tool to create resource catalog attributes for a CE, that will be uploaded to the CE collector.
+The CE Attributes Generator is a standalone tool to create resource catalog attributes for a CE, that will be uploaded to the CE collector.
 It is a lightweight alternative to OSG-Configure, and it prints the attributes instead of modifying your CE's config files.
 
-It uses `*.ini` files from osg-configure as the source of the data.
+It uses `*.ini` files from OSG-Configure as the source of the data.
 
 Installation
 ------------
 
-The Resource Catalog Generator is typically installed via RPMs from the OSG repositories.
+The CE Attributes Generator is typically installed via RPMs from the OSG repositories.
 See [OSG documentation for how to enable the repositories](https://opensciencegrid.org/docs/common/yum/);
 once the repos are enabled, install by running
 
-    yum install osg-resource-catalog-generator
+    yum install osg-ce-attributes-generator
 
-Note: osg-resource-catalog-generator is not available in the OSG 3.5 series.
+Note: `osg-ce-attributes-generator` is not available in the OSG 3.5 series.
 
 
 Configuration
 -------------
 
-The Resource Catalog Generator uses the same config files that OSG-Configure uses.
+The CE Attributes Generator uses the same config files that OSG-Configure uses.
 See the [31-cluster.ini](#31-clusterini--subcluster-and-resource-entry-sections),
 [35-pilot.ini](#35-pilotini--pilot) for attributes.
 
@@ -509,49 +509,45 @@ You will also need `resource` and `resource_group` from the `Site Information` s
 You can also use `--resource` and `--resource-group` on the command line to specify these.
 
 In addition, you should also have at least one batch system section with the attribute `enabled=True`, e.g.
-```
+```ini
 [Condor]
 enabled=True
 ```
 The recognized batch systems are "Condor", "LSF", "PBS", "SGE", and "SLURM".
+If you are using BOSCO, specify your batch system in `20-bosco.ini`.
 
 Alternatively, you can specify a comma-separated list with `--batch-systems` on the command line.
 
 
 Invocation
 ----------
 
-    osg-resource-catalog-generator [options]
-
-If invoked without any options, will read config from `/etc/osg/config.d/*.ini` and output to STDOUT.
-
-### Options
-
-- `-c FILE_OR_DIRECTORY`, `--config FILE_OR_DIRECTORY`
+    osg-ce-attributes-generator [<options>] [<config_location>] [<output>]
 
-  Where to load configuration from; can be specified multiple times.
+- `config_location` is a file or directory to load configuration from.
+  If this is a directory, load every `*.ini` file in that directory.
+  If `-`, read from STDIN. The default is to read `/etc/osg/config.d`,
+  same as `osg-configure`.
 
-  If this is a directory, will load every `*.ini` file in that directory. 
+- `output` is a file to write attributes to.
+  If `-` or unspecified, write to STDOUT.
 
-  If not specified, `/etc/osg/config.d` is used.
 
-  If `-`, will read from STDIN. STDIN will always be read last.
-
-- `-o FILE`, `--output FILE`
-
-  Write output to this file instead of STDOUT.
+### Options
 
 - `--resource RESOURCE_NAME`
 
   The Resource name to use, which should match your Topology registration.
-  This is an alternative to specifying `Site Information.resource` in the config files.
+  Equivalent to `resource` in the `Site Information` section.
 
 - `--resource-group RESOURCE_GROUP_NAME`
 
   The Resource Group name to use, which should match your Topology registration.
-  This is an alternative to specifying `Site Information.resource_group` in the config files.
-
+  Equivalent to `resource_group` in the `Site Information` section.
+  
 - `--batch-systems BATCH_SYSTEMS_LIST`
 
   A comma-separated list of batch systems used by the resource.
-  Recognized batch systems are: "Condor", "LSF", "PBS", "SGE", "SLURM".
+  Recognized batch systems are: `Condor`, `LSF`, `PBS`, `SGE`, and `SLURM`.
+  Equivalent to enabling the batch system sections in the
+  `20-*.ini` files, or, if using BOSCO, setting `batch` in the `BOSCO` section.

scripts/osg-ce-attribs-gen renamed to scripts/osg-ce-attributes-generator

@@ -1,11 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
-osg-ce-attribs-gen
-
-OSG CA Attributes File Generator
-
-Standalone script to generate a condor config file for advertising a CE resource to the CE Collector.
+OSG CE Attributes Generator:
+a standalone script to generate a condor config file for advertising
+a CE resource to the CE Collector.
 """
 
 from argparse import ArgumentParser
@@ -50,24 +48,22 @@ def load_configs(config_location: str) -> ConfigParser:
 
 def get_options(args):
     """Parse, validate, and transform command-line options."""
-    parser = ArgumentParser(prog="osg-ca-attrib-gen", description=__doc__)
+    parser = ArgumentParser(prog="osg-ce-attributes-generator", description=__doc__)
     parser.add_argument("--version", action="version", version="%(prog)s " + __version__)
     parser.add_argument(
         "config_location",
         nargs="?",
         default="/etc/osg/config.d",
-        metavar="FILE_OR_DIRECTORY",
-        help="Where to load configuration from. "
-             "If this is a directory, will load every *.ini file in that directory. "
-             "Default: %(default)s. "
-             "If '-', will read from STDIN.",
+        help="A file or directory to load configuration from. "
+             "If this is a directory, load every *.ini file in that directory. "
+             "If '-', read from STDIN. "
+             "Default: %(default)s.",
     )
     parser.add_argument(
         "output",
         nargs="?",
         default="-",
-        metavar="FILE",
-        help="Write output to this file.  If '-' or unspecified, will write to STDOUT.",
+        help="A file to write attributes to. If '-' or unspecified, write to STDOUT.",
     )
     parser.add_argument(
         "--resource",
@@ -90,7 +86,7 @@ def get_options(args):
         help="A comma-separated list of batch systems used by the resource. "
         f'Recognized batch systems are: {", ".join(BATCH_SYSTEMS)}. '
         "Equivalent to enabling the batch system sections in the 20-*.ini files, "
-        "or, if using Bosco, setting 'batch_system' in the 'Bosco' section."
+        "or, if using BOSCO, setting 'batch' in the 'BOSCO' section."
     )
 
     return parser.parse_args(args)
@@ -103,11 +99,14 @@ def main(argv):
         config = load_configs(options.config_location)
         if "Site Information" not in config:
             config.add_section("Site Information")
+        # Override config values with values from the command line
         if options.resource is not None:
             config["Site Information"]["resource"] = options.resource
         if options.resource_group is not None:
             config["Site Information"]["resource_group"] = options.resource_group
         if options.batch_systems is not None:
+            # hack since there's no (documented) Site Information.batch_systems option
+            # but I can still use it for passing a parameter
             config["Site Information"]["batch_systems"] = options.batch_systems
         output_str = get_ce_attributes_str(config)
         if options.output and options.output != "-":

setup.py

@@ -44,7 +44,7 @@ def get_data_files():
       maintainer_email='[email protected]',
       url='http://www.opensciencegrid.org',
       packages=['osg_configure', 'osg_configure.modules', 'osg_configure.configure_modules'],
-      scripts=['scripts/osg-configure', 'scripts/osg-ce-attribs-gen'],
+      scripts=['scripts/osg-configure', 'scripts/osg-ce-attributes-generator'],
       data_files=get_data_files(),
       classifiers=[
           "Development Status :: 6 - Mature",