]> git.madduck.net Git - etc/vim.git/blob - gallery/README.md

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:

cd73db90bf4d5ec3f59da682767a16e33348b467
[etc/vim.git] / gallery / README.md
1 # Gallery
2
3 Gallery is a script that automates process of applying different black versions to a
4 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 -b BLACK_REPO [-v VERSION] [-i INPUT] [-o OUTPUT] [versions ...]
20
21 Black Gallery is a script that automates process of applying different black versions to a selected PyPI package and seeing the results between versions.
22
23 positional arguments:
24   versions
25
26 optional arguments:
27   -h, --help            show this help message and exit
28   -p PYPI_PACKAGE, --pypi-package PYPI_PACKAGE
29                         PyPI package to download.
30   -b BLACK_REPO, --black-repo BLACK_REPO
31                         Black's git repository.
32   -v VERSION, --version VERSION
33                         Version for PyPI given pypi package.
34   -i INPUT, --input INPUT
35                         Input directory to read configurations.
36   -o OUTPUT, --output OUTPUT
37                         Output directory to download and put result artifacts.
38 ```