History

Panagiotis Vasilopoulos 06ccb88bf2 Replace references to master branch (#2210 ) Commit history before merge: * Replace references to master branch * Update .flake8 to reference docs on RTD We're moving away from GitHub as a documentation host to only RTD because it's makes our lives easier creating good docs. I know this link is dead right now, but it won't be once we release a new version with the documentation reorganization changes (which should be soon!). Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>		2021-05-09 17:50:17 -04:00
..
Dockerfile	Compress RUN statements into one to avoid layer proliferation	2020-03-17 11:33:57 +01:00
gallery.py	Replace references to master branch (#2210 )	2021-05-09 17:50:17 -04:00
README.md	Don't suggest using `sudo` with Docker	2020-03-17 11:35:41 +01:00

README.md

Gallery

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

$ docker build -t black_gallery .

Run

$ docker run -it -v /host/output:/output -v /host/input:/input black_gallery:latest [args]

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 the process of applying different Black versions to a selected PyPI package and
seeing the results between versions.

positional arguments:
  versions

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.
  -v VERSION, --version VERSION
                        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 configuration.
  -o OUTPUT, --output OUTPUT
                        Output directory to download and put result artifacts.