]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Update wording and formatting (#1302)
authorHugo van Kemenade <hugovk@users.noreply.github.com>
Mon, 9 Mar 2020 15:32:27 +0000 (17:32 +0200)
committerGitHub <noreply@github.com>
Mon, 9 Mar 2020 15:32:27 +0000 (15:32 +0000)
gallery/README.md
gallery/gallery.py

index cd73db90bf4d5ec3f59da682767a16e33348b467..ed3764044b65502cdfd865e2b9cbe3d9b9545e05 100644 (file)
@@ -1,7 +1,7 @@
 # Gallery
 
 # Gallery
 
-Gallery is a script that automates process of applying different black versions to a
-selected PyPI package and seeing the results between black versions.
+Gallery is a script that automates the process of applying different _Black_ versions to
+a selected PyPI package and seeing the results between _Black_ versions.
 
 ## Build
 
 
 ## Build
 
@@ -16,9 +16,11 @@ $ sudo docker run -it -v /host/output:/output -v /host/input:/input black_galler
 ```
 
 ```
 ```
 
 ```
-usage: gallery.py [-h] -p PYPI_PACKAGE -b BLACK_REPO [-v VERSION] [-i INPUT] [-o OUTPUT] [versions ...]
+usage: gallery.py [-h] (-p PYPI_PACKAGE | -t TOP_PACKAGES) [-b BLACK_REPO] [-v VERSION] [-w WORKERS] [-i INPUT] [-o OUTPUT]
+                  [versions [versions ...]]
 
 
-Black Gallery is a script that automates process of applying different black versions to a selected PyPI package and seeing the results between versions.
+Black Gallery is a script that automates the process of applying different Black versions to a selected PyPI package and
+seeing the results between versions.
 
 positional arguments:
   versions
 
 positional arguments:
   versions
@@ -27,12 +29,17 @@ optional arguments:
   -h, --help            show this help message and exit
   -p PYPI_PACKAGE, --pypi-package PYPI_PACKAGE
                         PyPI package to download.
   -h, --help            show this help message and exit
   -p PYPI_PACKAGE, --pypi-package PYPI_PACKAGE
                         PyPI package to download.
+  -t TOP_PACKAGES, --top-packages TOP_PACKAGES
+                        Top n PyPI packages to download.
   -b BLACK_REPO, --black-repo BLACK_REPO
   -b BLACK_REPO, --black-repo BLACK_REPO
-                        Black's git repository.
+                        Black's Git repository.
   -v VERSION, --version VERSION
   -v VERSION, --version VERSION
-                        Version for PyPI given pypi package.
+                        Version for given PyPI package. Will be discarded if used with -t option.
+  -w WORKERS, --workers WORKERS
+                        Maximum number of threads to download with at the same time. Will be discarded if used with -p
+                        option.
   -i INPUT, --input INPUT
   -i INPUT, --input INPUT
-                        Input directory to read configurations.
+                        Input directory to read configuration.
   -o OUTPUT, --output OUTPUT
                         Output directory to download and put result artifacts.
 ```
   -o OUTPUT, --output OUTPUT
                         Output directory to download and put result artifacts.
 ```
index eafa02f210c9b6140b431561b348171ad9980f30..87a305fe5468bd723eeda56eb6363baa379ad225 100755 (executable)
@@ -51,7 +51,7 @@ def get_pypi_download_url(package: str, version: Optional[str]) -> str:
             sources = metadata["releases"][version]
         else:
             raise ValueError(
             sources = metadata["releases"][version]
         else:
             raise ValueError(
-                f"No releases found with given version ('{version}') tag. "
+                f"No releases found with version ('{version}') tag. "
                 f"Found releases: {metadata['releases'].keys()}"
             )
 
                 f"Found releases: {metadata['releases'].keys()}"
             )
 
@@ -253,22 +253,22 @@ def format_repos(repos: Tuple[Path, ...], options: Namespace) -> None:
 def main() -> None:
     parser = ArgumentParser(
         description="""Black Gallery is a script that
 def main() -> None:
     parser = ArgumentParser(
         description="""Black Gallery is a script that
-    automates process of applying different black versions to a selected
+    automates the process of applying different Black versions to a selected
     PyPI package and seeing the results between versions."""
     )
 
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument("-p", "--pypi-package", help="PyPI package to download.")
     group.add_argument(
     PyPI package and seeing the results between versions."""
     )
 
     group = parser.add_mutually_exclusive_group(required=True)
     group.add_argument("-p", "--pypi-package", help="PyPI package to download.")
     group.add_argument(
-        "-t", "--top-packages", help="Top n PyPI package to download.", type=int
+        "-t", "--top-packages", help="Top n PyPI packages to download.", type=int
     )
 
     )
 
-    parser.add_argument("-b", "--black-repo", help="Black's git repository.", type=Path)
+    parser.add_argument("-b", "--black-repo", help="Black's Git repository.", type=Path)
     parser.add_argument(
         "-v",
         "--version",
         help=(
     parser.add_argument(
         "-v",
         "--version",
         help=(
-            "Version for PyPI given pypi package. "
+            "Version for given PyPI package. "
             "Will be discarded if used with -t option."
         ),
     )
             "Will be discarded if used with -t option."
         ),
     )
@@ -276,8 +276,8 @@ def main() -> None:
         "-w",
         "--workers",
         help=(
         "-w",
         "--workers",
         help=(
-            "Maximum amount of threads to download at the sametime. "
-            "Will be discard if used with -p option."
+            "Maximum number of threads to download with at the same time. "
+            "Will be discarded if used with -p option."
         ),
     )
     parser.add_argument(
         ),
     )
     parser.add_argument(
@@ -285,7 +285,7 @@ def main() -> None:
         "--input",
         default=Path("/input"),
         type=Path,
         "--input",
         default=Path("/input"),
         type=Path,
-        help="Input directory to read configurations.",
+        help="Input directory to read configuration.",
     )
     parser.add_argument(
         "-o",
     )
     parser.add_argument(
         "-o",