getpass alternative with masking, Spyder support and additional features
Project description
Maskpass
Maskpass is a Python library like getpass but with advanced features like masking and reveal/unreveal.
It also works in Spyder IDLE
Installation
Use the package manager pip to install maskpass.
pip install maskpass
Usage
This module contains functions askpass() and advpass()
askpass() uses msvcrt.getch() in windows and altenatives in *nix OS, but it doesn't work in Spyder.
import maskpass
password=maskpass.askpass()
The function returns the entered password in string format
Accepts 2 optional arguments prompt and mask. Default for prompt is Enter password:
. Default for mask is *
.
Use mask=""
for not echoing anything into the terminal. (Like entering sudo passwords in *nix)
Using advpass()
advpass() uses pynput to get the password, and it works in Spyder too!
import maskpass
password=maskpass.advpass()
The function returns the entered password in string format.
Accepts 3 optional arguments prompt, mask and idle. Default for prompt is Enter password:
. Default for mask is *
.
idle expects a bool, it is for overriding IDLE check, and has default False. Usually there is no need to change this, since it's automatically checked whether it's running on IDLE or terminal.
advpass()
also has a revealing feature which will toggle the visibility of the entered password when Left CTRL
is pressed. Press it again to change back the visibility.
Note: Only works with advpass()
and needs pynput
Screenshots
Normal askpass
advpass in Spyder
advpass in terminal
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Issues
Currently I have only tested it in Windows 10, Manjaro and Parrot, so I'm not sure it works in macOS.
The advpass()
works well in Spyder, Windows cmd/powershell/terminal and Linux terminal.
Haven't tested it in PyCharm yet, so it might work.
License
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.