Unverified Commit 3ac97a30 authored by Hugo van Kemenade's avatar Hugo van Kemenade Committed by GitHub
Browse files

Update wording and formatting (#1302)

parent 9a50ba26
Loading
Loading
Loading
Loading
+14 −7
Changes for gallery/README.md: 14 added lines, 7 removed lines.
Original line number Diff line number Diff line
# 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

@@ -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
@@ -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.
  -t TOP_PACKAGES, --top-packages TOP_PACKAGES
                        Top n PyPI packages to download.
  -b BLACK_REPO, --black-repo BLACK_REPO
                        Black's git repository.
                        Black's Git repository.
  -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
                        Input directory to read configurations.
                        Input directory to read configuration.
  -o OUTPUT, --output OUTPUT
                        Output directory to download and put result artifacts.
```
+8 −8
Changes for gallery/gallery.py: 8 added lines, 8 removed lines.
Original line number Diff line number Diff line
@@ -51,7 +51,7 @@ def get_pypi_download_url(package: str, version: Optional[str]) -> str:
            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()}"
            )

@@ -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
    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(
        "-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=(
            "Version for PyPI given pypi package. "
            "Version for given PyPI package. "
            "Will be discarded if used with -t option."
        ),
    )
@@ -276,8 +276,8 @@ def main() -> None:
        "-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(
@@ -285,7 +285,7 @@ def main() -> None:
        "--input",
        default=Path("/input"),
        type=Path,
        help="Input directory to read configurations.",
        help="Input directory to read configuration.",
    )
    parser.add_argument(
        "-o",