Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Packaging #80

Merged
merged 12 commits into from Apr 21, 2022
Merged

Packaging #80

merged 12 commits into from Apr 21, 2022

Conversation

eggplants
Copy link
Contributor

@eggplants eggplants commented Apr 20, 2022

I have packaged this project. It enables to be easy to install and use as CLI commands (depix, genpixed). And I added type hints in mypy-strict mode.

If you don't mind, please publish this on PyPI!

ref: https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives

@eggplants eggplants marked this pull request as draft April 20, 2022 20:43
@eggplants eggplants marked this pull request as ready for review April 20, 2022 22:46
@eggplants
Copy link
Contributor Author

image

@eggplants
Copy link
Contributor Author

$ depix -h
usage: depix [-h] -p PATH -s PATH [-a TYPE] [-b RGB] [-o PATH] [-V]

This command recovers passwords from pixelized screenshots.

optional arguments:
  -h, --help                     show this help message and exit
  -p PATH, --pixelimage PATH     path to image with pixelated rectangle
  -s PATH, --searchimage PATH    path to image with patterns to search
  -a TYPE, --averagetype TYPE    type of RGB average to use (default: gammacorrected)
  -b RGB, --backgroundcolor RGB  original editor background color in format r,g,b (default: None)
  -o PATH, --outputimage PATH    path to output image (default: output.png)
  -V, --version                  show program's version number and exit

note:
    The pixelated rectangle must be cut out to only include the pixelated rectangles.
    The pattern search image is generally a screenshot of a De Bruijn sequence of expected characters,
    made on a machine with the same editor and text size as the original screenshot that was pixelated.

$ genpixed -h
usage: genpixed [-h] -i PATH [-o PATH] [-V]

This command generates pixelized image from a given image.

optional arguments:
  -h, --help                   show this help message and exit
  -i PATH, --image PATH        path to image to pixelize (default: None)
  -o PATH, --outputimage PATH  path to output image (default: output.png)
  -V, --version                show program's version number and exit

@spipm spipm merged commit 9dad55e into spipm:main Apr 21, 2022
@spipm
Copy link
Owner

spipm commented Apr 21, 2022

Awesome! Thank you very much

@eggplants eggplants deleted the packaging branch April 21, 2022 14:54
@eggplants
Copy link
Contributor Author

eggplants commented Jun 15, 2022

@Kayizt
Copy link

Kayizt commented Aug 25, 2023

note:
The pixelated rectangle must be cut out to only include the pixelated rectangles.
The pattern search image is generally a screenshot of a De Bruijn sequence of expected characters,
made on a machine with the same editor and text size as the original screenshot that was pixelated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants