Merge pull request #17 from sarnold/doc-updates

pre-release cleanup

Author: sarnold

.pre-commit-config.yaml

@@ -41,7 +41,7 @@ repos:
         args: [--settings-path=pyproject.toml]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.16.0
     hooks:
     - id: mypy
       args:
@@ -89,7 +89,7 @@ repos:
           - --remove-unused-variables
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.1.2
+    rev: 7.2.0
     hooks:
       - id: flake8
         files: procman/

CHANGELOG.rst

@@ -2,7 +2,53 @@ Changelog
 =========
 
 
-0.4.0 (2025-03-15)
+0.5.0 (2025-05-30)
+------------------
+
+Changes
+~~~~~~~
+- Update readme and help strings, cleanup project files. [Stephen L
+  Arnold]
+- Refactor part 2, wire up config file as positional arg. [Stephen L
+  Arnold]
+
+  * add file arg to load_config, update test and entry point
+- Refactor part 1, decouple util funcs, add user config arg. [Stephen L
+  Arnold]
+
+  * tests and entrypoint are updated, but config arg is not wired up yet
+- Update docs config and deps. [Stephen L Arnold]
+
+Fixes
+~~~~~
+- Cleanup old runners in coverage workflow, update project files.
+  [Stephen L Arnold]
+- Add type annotations and cleanup imports, add mypy config. [Stephen L
+  Arnold]
+
+Other
+~~~~~
+- Merge pull request #16 from sarnold/cleanup-bits. [Steve Arnold]
+
+  more config
+
+
+0.4.1 (2025-03-18)
+------------------
+
+Changes
+~~~~~~~
+- Update to latest bandit action for testing, fix readme. [Stephen L
+  Arnold]
+
+Other
+~~~~~
+- Merge pull request #12 from sarnold/doc-nits. [Steve Arnold]
+
+  Action update
+
+
+0.4.0 (2025-03-16)
 ------------------
 
 Changes
@@ -24,10 +70,19 @@ Changes
 
 Fixes
 ~~~~~
+- Make sure release workflow has the right job permissions. [Stephen L
+  Arnold]
+- Update gitchangelog and add config, fix readme URI. [Stephen L Arnold]
 - Move description text and add version. [Stephen L Arnold]
 
 Other
 ~~~~~
+- Merge pull request #11 from sarnold/release-docs. [Steve Arnold]
+
+  release workflow fixes
+- Merge pull request #10 from sarnold/changelog-fix. [Steve Arnold]
+
+  changelog fixes
 - Merge pull request #9 from sarnold/action-hashes. [Steve Arnold]
 
   workflow linting

README.rst

@@ -60,25 +60,41 @@ details).
 The current version supports minimal command options and there are no
 required arguments::
 
-  (dev) user@host $ procman
-  usage: procman [-h] [-v] [-d] [-c RUNFOR] [-D] [-t] [--version] [-S]
+  (dev) user@host $ procman -h
+  usage: procman [-h] [--version] [-D] [-S] [-t] [-v] [-d] [-c RUNFOR] [FILE]
 
   Process manager for user scripts
 
+  positional arguments:
+    FILE                  path to user-defined yaml configuration (default:
+                          None)
+
   options:
     -h, --help            show this help message and exit
-    -v, --verbose         Display more processing info (default: False)
+    --version             show program's version number and exit
+    -D, --demo            run demo config (default: False)
+    -S, --show            display user config (default: False)
+    -t, --test            run sanity checks (default: False)
+    -v, --verbose         display more processing info (default: False)
     -d, --dump-config     dump active yaml configuration to stdout (default:
                           False)
-    -c RUNFOR, --countdown RUNFOR
-                          Runtime STOP timer in seconds - 0 means run until
-                          whenever (default: 0)
-    -D, --demo            Run demo config (default: False)
-    -t, --test            Run sanity checks (default: False)
-    --version             show program's version number and exit
-    -S, --show            Display user data paths (default: False)
+    -c, --countdown RUNFOR
+                          runtime STOP timer in seconds - 0 means run forever
+                          (default: 0)
+
+Configuration options
+---------------------
+
+There are several ways to apply your own configuration:
+
+* use default filename pattern in project root, either ``.procman`` or
+  ``procman`` with a YAML extension of ``.yml`` or ``.yaml``
+
+* use any filename with YAML extension passed as positional argument, eg
+  something like ``procman custom_config.yaml``
 
-  No cfg file found; use the --demo arg or create a cfg file
+* set the ``PROCMAN_CFG`` environment variable to something like
+  ``my/path/to/config.yaml``
 
 
 Usage
@@ -251,7 +267,7 @@ To build/lint the html docs, use the following tox commands:
 To install the latest release, eg with your own ``tox.ini`` file in
 another project, use something like this::
 
-  $ pip install -U https://github.com/sarnold/procman/releases/download/0.1.0/procman-0.1.0-py3-none-any.whl
+  $ pip install -U https://github.com/sarnold/procman/releases/download/0.1.0/procman-0.4.1-py3-none-any.whl
 
 
 .. _Tox: https://github.com/tox-dev/tox
@@ -381,7 +397,7 @@ specifications.
     :target: https://github.com/sarnold/procman/releases
     :alt: GitHub tag
 
-.. |python| image:: https://img.shields.io/badge/python-3.6+-blue.svg
+.. |python| image:: https://img.shields.io/badge/python-3.9+-blue.svg
     :target: https://www.python.org/downloads/
     :alt: Python
 

procman/procman.py

@@ -82,19 +82,19 @@ def main(argv=None):  # pragma: no cover
         description='Process manager for user scripts',
     )
     parser.add_argument('--version', action="version", version=f"%(prog)s {VERSION}")
-    parser.add_argument('-D', '--demo', help='Run demo config', action='store_true')
-    parser.add_argument('-S', '--show', help='Display user config', action='store_true')
-    parser.add_argument('-t', '--test', help='Run sanity checks', action='store_true')
+    parser.add_argument('-D', '--demo', help='run demo config', action='store_true')
+    parser.add_argument('-S', '--show', help='display user config', action='store_true')
+    parser.add_argument('-t', '--test', help='run sanity checks', action='store_true')
     parser.add_argument(
         "-v",
         "--verbose",
         action="store_true",
-        help="Display more processing info",
+        help="display more processing info",
     )
     parser.add_argument(
         '-d',
         '--dump-config',
-        help="Dump active yaml configuration to stdout",
+        help="dump active yaml configuration to stdout",
         action='store_true',
         dest="dump",
     )
@@ -104,14 +104,14 @@ def main(argv=None):  # pragma: no cover
         type=int,
         default='0',
         dest="runfor",
-        help="Runtime STOP timer in seconds - 0 means run forever",
+        help="runtime STOP timer in seconds - 0 means run forever",
     )
     parser.add_argument(
         'file',
         nargs='?',
         metavar="FILE",
         type=str,
-        help="Path to user-defined yaml configuration",
+        help="path to user-defined yaml configuration",
     )
 
     args = parser.parse_args()

setup.cfg

@@ -8,7 +8,7 @@ author_email = nerdboy@gentoo.org
 long_description = file: README.rst
 long_description_content_type = text/x-rst
 license_expression = LGPL-2.1-or-later
-license_files = LICENSE
+license_files = COPYING
 classifiers =
     Development Status :: 4 - Beta
     Intended Audience :: Developers
@@ -18,14 +18,13 @@ classifiers =
     Topic :: Software Development :: Testing
 
 [options]
-python_requires = >= 3.8
+python_requires = >= 3.9
 
 setup_requires =
     setuptools_scm[toml]
 
 install_requires =
     honcho
-    importlib-metadata; python_version < '3.8'
     importlib_resources; python_version < '3.10'
     munch[yaml]
 

tox.ini

@@ -219,7 +219,7 @@ deps =
 
 commands =
     pip install procman --force --pre --prefer-binary -f dist/
-    procman --version
+    procman -h
     procman --dump-config
 
 [testenv:lint]