fotolab 0.16.5__tar.gz → 0.16.6__tar.gz

{fotolab-0.16.5 → fotolab-0.16.6}/.pre-commit-config.yaml

@@ -77,7 +77,7 @@ repos:
         language_version: python3.12
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 7.0.0
+    rev: 7.1.0
     hooks:
       - id: flake8
         language_version: python3.12

{fotolab-0.16.5 → fotolab-0.16.6}/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [0-based versioning](https://0ver.org/).
 
 ## [Unreleased]
 
+## v0.16.6 (2024-06-23)
+
+- Add `readme` session to `nox`
+- Bump deps and `pre-commit` hooks
+- Set CLI program name explicitly
+
 ## v0.16.5 (2024-06-16)
 
 - Bump, sort, and remove unused deps

{fotolab-0.16.5 → fotolab-0.16.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fotolab
-Version: 0.16.5
+Version: 0.16.6
 Summary: A console program that manipulate images.
 Keywords: photography,photo
 Author-email: Kian-Meng Ang <kianmeng@cpan.org>
@@ -56,10 +56,11 @@ python -m pip install -e git+https://github.com/kianmeng/fotolab.git
 fotolab -h
 ```
 
+<!--help !-->
+
 ```console
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
-               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
-               ...
+               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env} ...
 
 A console program to manipulate photos.
 
@@ -94,6 +95,8 @@ optional arguments:
   -V, --version     show program's version number and exit
 ```
 
+<!--help !-->
+
 ### fotolab animate
 
 ```console

{fotolab-0.16.5 → fotolab-0.16.6}/Pipfile.lock

@@ -104,11 +104,11 @@
         },
         "argcomplete": {
             "hashes": [
-                "sha256:c168c3723482c031df3c207d4ba8fa702717ccb9fc0bfe4117166c1f537b4a54",
-                "sha256:fd03ff4a5b9e6580569d34b273f741e85cd9e072f3feeeee3eba4891c70eda62"
+                "sha256:69a79e083a716173e5532e0fa3bef45f793f4e61096cf52b5a42c0211c8b8aa5",
+                "sha256:c2abcdfe1be8ace47ba777d4fce319eb13bf8ad9dace8d085dcad6eded88057f"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==3.3.0"
+            "version": "==3.4.0"
         },
         "astor": {
             "hashes": [
@@ -349,11 +349,11 @@
         },
         "flake8": {
             "hashes": [
-                "sha256:33f96621059e65eec474169085dc92bf26e7b2d47366b70be2f67ab80dc25132",
-                "sha256:a6dfbb75e03252917f2473ea9653f7cd799c3064e54d4c8140044c5c065f53c3"
+                "sha256:2e416edcc62471a64cea09353f4e7bdba32aeb079b6e360554c659a122b1bc6a",
+                "sha256:48a07b626b55236e0fb4784ee69a465fbf59d79eec1f5b4785c3d3bc57d17aa5"
             ],
             "markers": "python_full_version >= '3.8.1'",
-            "version": "==7.0.0"
+            "version": "==7.1.0"
         },
         "flake8-docstrings": {
             "hashes": [
@@ -687,11 +687,11 @@
         },
         "pycodestyle": {
             "hashes": [
-                "sha256:41ba0e7afc9752dfb53ced5489e89f8186be00e599e712660695b7a75ff2663f",
-                "sha256:44fe31000b2d866f2e41841b18528a505fbd7fef9017b04eff4e2648a0fadc67"
+                "sha256:442f950141b4f43df752dd303511ffded3a04c2b6fb7f65980574f0c31e6e79c",
+                "sha256:949a39f6b86c3e1515ba1787c2022131d165a8ad271b11370a8819aa070269e4"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==2.11.1"
+            "version": "==2.12.0"
         },
         "pydocstyle": {
             "hashes": [
@@ -843,12 +843,12 @@
         },
         "sphinx-autodoc-typehints": {
             "hashes": [
-                "sha256:0072b65f5ab2818c229d6d6c2cc993770af55d36bb7bfb16001e2fce4d14880c",
-                "sha256:22427d74786274add2b6d4afccb8b3c8c1843f48a704550f15a35fd948f8a4de"
+                "sha256:143e22dbb096cc39f1559d3accbe423e5fbf04d02849d6564e6471b5616bbd97",
+                "sha256:a21f0120d8657545ad5ec269d7276b0718c367c8ff2fa8ad8767ddf2c660b909"
             ],
             "index": "pypi",
             "markers": "python_version >= '3.9'",
-            "version": "==2.1.1"
+            "version": "==2.2.0"
         },
         "sphinx-copybutton": {
             "hashes": [
@@ -918,11 +918,11 @@
         },
         "urllib3": {
             "hashes": [
-                "sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d",
-                "sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19"
+                "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472",
+                "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"
             ],
             "markers": "python_version >= '3.8'",
-            "version": "==2.2.1"
+            "version": "==2.2.2"
         },
         "virtualenv": {
             "hashes": [

{fotolab-0.16.5 → fotolab-0.16.6}/README.md

@@ -34,10 +34,11 @@ python -m pip install -e git+https://github.com/kianmeng/fotolab.git
 fotolab -h
 ```
 
+<!--help !-->
+
 ```console
 usage: fotolab [-h] [-o] [-op] [-od OUTPUT_DIR] [-q] [-v] [-d] [-V]
-               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env}
-               ...
+               {animate,auto,border,contrast,info,resize,rotate,montage,sharpen,watermark,env} ...
 
 A console program to manipulate photos.
 
@@ -72,6 +73,8 @@ optional arguments:
   -V, --version     show program's version number and exit
 ```
 
+<!--help !-->
+
 ### fotolab animate
 
 ```console

{fotolab-0.16.5 → fotolab-0.16.6}/fotolab/__init__.py

@@ -21,7 +21,7 @@ import subprocess
 import sys
 from pathlib import Path
 
-__version__ = "0.16.5"
+__version__ = "0.16.6"
 
 log = logging.getLogger(__name__)
 

{fotolab-0.16.5 → fotolab-0.16.6}/fotolab/cli.py

@@ -68,6 +68,7 @@ def setup_logging(args: argparse.Namespace) -> None:
 def build_parser() -> argparse.ArgumentParser:
     """Build the CLI parser."""
     parser = argparse.ArgumentParser(
+        prog="fotolab",
         description=__doc__,
         formatter_class=lambda prog: argparse.RawTextHelpFormatter(
             prog, max_help_position=20

{fotolab-0.16.5 → fotolab-0.16.6}/noxfile.py

@@ -14,8 +14,12 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
 """Nox configuration."""
+from io import StringIO
+
 import nox
 
+from fotolab.cli import build_parser
+
 
 @nox.session()
 def deps(session: nox.Session) -> None:
@@ -60,3 +64,21 @@ def doc(session: nox.Session) -> None:
     """Build doc with sphinx."""
     session.run("pipenv", "install", "--dev", external=True)
     session.run("sphinx-build", "docs/source/", "docs/build/html")
+
+
+@nox.session(python="3.12", reuse_venv=True)
+def readme(_session: nox.Session) -> None:
+    """Update console help menu to readme."""
+    with open("README.md", "r+", encoding="utf8") as f:
+        content = f.read()
+        marker = content.split("<!--help !-->")[1]
+
+        buffer = StringIO()
+        parser = build_parser()
+        parser.print_help(file=buffer)
+
+        help_message = f"\n\n```console\n{buffer.getvalue()}```\n\n"
+        readme_md = content.replace(marker, help_message)
+
+        f.seek(0)
+        f.write(readme_md)