gallery/README.md

   1 # Gallery
   2
   3 Gallery is a script that automates the process of applying different _Black_ versions to
   4 a selected PyPI package and seeing the results between _Black_ versions.
   5
   6 ## Build
   7
   8 ```console
   9 $ [sudo] docker build -t black_gallery .
  10 ```
  11
  12 ## Run
  13
  14 ```console
  15 $ sudo docker run -it -v /host/output:/output -v /host/input:/input black_gallery:latest [args]
  16 ```
  17
  18 ```
  19 usage: gallery.py [-h] (-p PYPI_PACKAGE | -t TOP_PACKAGES) [-b BLACK_REPO] [-v VERSION] [-w WORKERS] [-i INPUT] [-o OUTPUT]
  20                   [versions [versions ...]]
  21
  22 Black Gallery is a script that automates the process of applying different Black versions to a selected PyPI package and
  23 seeing the results between versions.
  24
  25 positional arguments:
  26   versions
  27
  28 optional arguments:
  29   -h, --help            show this help message and exit
  30   -p PYPI_PACKAGE, --pypi-package PYPI_PACKAGE
  31                         PyPI package to download.
  32   -t TOP_PACKAGES, --top-packages TOP_PACKAGES
  33                         Top n PyPI packages to download.
  34   -b BLACK_REPO, --black-repo BLACK_REPO
  35                         Black's Git repository.
  36   -v VERSION, --version VERSION
  37                         Version for given PyPI package. Will be discarded if used with -t option.
  38   -w WORKERS, --workers WORKERS
  39                         Maximum number of threads to download with at the same time. Will be discarded if used with -p
  40                         option.
  41   -i INPUT, --input INPUT
  42                         Input directory to read configuration.
  43   -o OUTPUT, --output OUTPUT
  44                         Output directory to download and put result artifacts.
  45 ```