[README.md] Expand version range; include --help text ; [.github/workflows/python-package.yml] Bump versions ; expand version range ; [nginxctl/__main__.py] Fix help text on macOS ; [LICENSE-{APACHE,MIT}] Bump year range

Author: SamuelMarks

.github/workflows/python-package.yml

@@ -12,22 +12,22 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-          python-version: [ 2.7, 3.5, 3.6, 3.7, 3.8, 3.9 ]
+          python-version: [ 2.7, 3.5, 3.6, 3.7, 3.8, 3.9, '3.10', 3.11, 3.12, 3.13 ]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools wheel
-        pip install -r requirements.txt
+        python -m pip install -r requirements.txt
     - name: Lint with flake8
       run: |
-        pip install flake8
-          flake8 . --count --select=$(printf '%s,' {A..Z}) --ignore='W503,E203' --show-source --max-complexity=13 --max-line-length=119 --statistics
+        python -m pip install flake8
+        flake8 . --count --select=$(printf '%s,' {A..Z}) --ignore='W503,E203' --show-source --max-complexity=13 --max-line-length=119 --statistics
     - name: Test with unittest
       run: |
-          python setup.py test
+        python setup.py test

LICENSE-APACHE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2020 Samuel Marks (for Offscale.io)
+   Copyright 2020–2025 Samuel Marks (for Offscale.io)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright 2020 Samuel Marks (for Offscale.io)
+Copyright 2020–2025 Samuel Marks (for Offscale.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,7 +1,7 @@
 nginxctl
 ========
 [![License](https://img.shields.io/badge/license-Apache--2.0%20OR%20MIT%20OR%20CC0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
-![Python version range](https://img.shields.io/badge/python-2.7%20|%203.5%20|%203.6%20|%203.7%20|%203.8%20|3.9-blue.svg)
+![Python version range](https://img.shields.io/badge/python-2.7%20|%203.5%20|%203.6%20|%203.7%20|%203.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12%20|%203.13-blue.svg)
 ![Python lint & test](https://github.com/offscale/nginxctl/workflows/Python%20lint%20&%20test/badge.svg)
 [![black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
@@ -16,6 +16,43 @@ Commands for modifying and controlling nginx over the command-line.
 
     pip install .
 
+## Usage
+
+    usage: python -m nginxctl [-h] [--version] [--listen [LISTEN ...]]
+                              [--prefix PREFIX] [--temp_dir TEMP_DIR]
+                              [--nginx NGINX] [-b [BLOCK ...]] [-c CONFIG]
+                              [-{ [OPEN_PAREN ...]] [-} [CLOSE_PAREN ...]]
+                              {dry_run,emit,nginx,serve,upsert}
+    
+    Commands for modifying and controlling nginx over the command-line.
+    
+    positional arguments:
+      {dry_run,emit,nginx,serve,upsert}
+                            serve, emit, nginx, or dry_run
+    
+    options:
+      -h, --help            show this help message and exit
+      --version             show program's version number and exit
+      --listen [LISTEN ...]
+                            Listen (e.g., port)
+      --prefix PREFIX       set prefix path, e.g., '/opt/homebrew/etc/nginx'
+      --temp_dir TEMP_DIR   serve uses this directory
+      --nginx NGINX         Path to nginx binary, defaults to first in PATH, i.e.,
+                            '/opt/homebrew/bin/nginx'
+      -b [BLOCK ...], --block [BLOCK ...]
+                            Block, e.g., server or http
+      -c CONFIG, --config CONFIG
+                            Name of file. Placed in prefix folder—e.g.,
+                            '/opt/homebrew/bin/nginx'—if not absolute. E.g.,
+                            nginx.conf
+      -{ [OPEN_PAREN ...]   Starting parentheses (raise hierarchy). Note:
+                            `-b`/`--block` does this also.
+      -} [CLOSE_PAREN ...]  Ending parentheses (lower hierarchy)
+    
+    Example usage: python -m nginxctl -w '/tmp/wwwroot' -p 8080 -i '192.168.2.1'
+    -w '/mnt/webroot' -p 9001 -i 'localhost' --path '/api' --proxy-pass
+    '192.168.2.1/api'
+
 ## Examples
 
 ### Serve local directory and then stop server

nginxctl/__main__.py

@@ -67,11 +67,8 @@ def _build_parser():
         default_nginx_usage = next(
             line for line in strings(default_nginx) if "set prefix path" in line
         ).split()
-        default_prefix, default_conf = tuple(
-            l[:-1]
-            for i, l in enumerate(default_nginx_usage)
-            if i > 0 and "default" in default_nginx_usage[i - 1]
-        )
+        default_conf = next(filter(lambda s: s.endswith('nginx.conf)'), default_nginx_usage))[:-1]
+        default_prefix = os.path.dirname(default_conf)
 
     parser = ArgumentParser(
         prog="python -m {}".format(PythonPackageInfo().get_app_name()),

nginxctl/tests/test_parser.py

@@ -12,7 +12,7 @@
 from boltons.iterutils import remap
 from pkg_resources import resource_filename
 
-from nginxctl.helpers import del_keys_d, get_dict_by_key_val, update_directive
+from nginxctl.helpers import del_keys_d, get_dict_by_key_val, update_directive, pp
 from nginxctl.parser import parse_cli_config
 from nginxctl.pkg_utils import PythonPackageInfo
 
@@ -45,6 +45,7 @@ def tearDown(self):
         rmtree(self.temp_dir)
 
     def test_filter_map_block(self):
+        pp(self.nginx_conf_parse)
         for config in self.nginx_conf_parse["config"]:
             self.assertEqual(config["status"], "ok")