stdiomask

Name	stdiomask JSON
Version	0.0.6 JSON
	download
home_page	https://github.com/asweigart/stdiomask
Summary	A cross-platform Python module for entering passwords to a stdio terminal and displaying a **** mask, which getpass cannot do.
upload_time	2020-10-11 02:32:50
maintainer
docs_url	None
author	Al Sweigart
requires_python
license	GPLv3+
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            Stdio Mask
======

A cross-platform Python module for entering passwords to a stdio terminal and displaying a **** mask, which getpass cannot do.

Installation
------------

To install with pip, run:

    pip install stdiomask

Quickstart Guide
----------------

The `getpass.getpass()` function in the Python Standard Library won't display "mask" characters as you type; it only displays nothing as you type. If you want mask characters to appear, you can use the `stdio.getpass()` function instead.

Typical usage:

    >>> import stdiomask
    >>> stdiomask.getpass()
    Password: *********
    'swordfish'
    >>> stdiomask.getpass(prompt='PW: ')
    PW: *********
    'swordfish'
    >>> stdiomask.getpass(mask='X')
    Password: XXXXXXXXX
    'swordfish'
    >>> stdiomask.getpass(mask='') # Falls back and calls getpass.getpass()
    Password:
    'swordfish'

Contribute
----------

If you'd like to contribute to Stdio Mask, check out https://github.com/asweigart/stdiomask
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/asweigart/stdiomask",
    "name": "stdiomask",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Al Sweigart",
    "author_email": "al@inventwithpython.com",
    "download_url": "https://files.pythonhosted.org/packages/47/a2/f72fd263cecb11ed4cc96bd31608359e1df30349c665674e5c35ea9a72d6/stdiomask-0.0.6.tar.gz",
    "platform": "",
    "description": "Stdio Mask\n======\n\nA cross-platform Python module for entering passwords to a stdio terminal and displaying a **** mask, which getpass cannot do.\n\nInstallation\n------------\n\nTo install with pip, run:\n\n    pip install stdiomask\n\nQuickstart Guide\n----------------\n\nThe `getpass.getpass()` function in the Python Standard Library won't display \"mask\" characters as you type; it only displays nothing as you type. If you want mask characters to appear, you can use the `stdio.getpass()` function instead.\n\nTypical usage:\n\n    >>> import stdiomask\n    >>> stdiomask.getpass()\n    Password: *********\n    'swordfish'\n    >>> stdiomask.getpass(prompt='PW: ')\n    PW: *********\n    'swordfish'\n    >>> stdiomask.getpass(mask='X')\n    Password: XXXXXXXXX\n    'swordfish'\n    >>> stdiomask.getpass(mask='') # Falls back and calls getpass.getpass()\n    Password:\n    'swordfish'\n\nContribute\n----------\n\nIf you'd like to contribute to Stdio Mask, check out https://github.com/asweigart/stdiomask",
    "bugtrack_url": null,
    "license": "GPLv3+",
    "summary": "A cross-platform Python module for entering passwords to a stdio terminal and displaying a **** mask, which getpass cannot do.",
    "version": "0.0.6",
    "project_urls": {
        "Homepage": "https://github.com/asweigart/stdiomask"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "47a2f72fd263cecb11ed4cc96bd31608359e1df30349c665674e5c35ea9a72d6",
                "md5": "1219b14c39ea578ff968c8497ccdfa0d",
                "sha256": "c1e47069ead9e10bda150a26f7922ca01d2adc503042a9d7acf64877a2b9a3a6"
            },
            "downloads": -1,
            "filename": "stdiomask-0.0.6.tar.gz",
            "has_sig": false,
            "md5_digest": "1219b14c39ea578ff968c8497ccdfa0d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3628,
            "upload_time": "2020-10-11T02:32:50",
            "upload_time_iso_8601": "2020-10-11T02:32:50.698345Z",
            "url": "https://files.pythonhosted.org/packages/47/a2/f72fd263cecb11ed4cc96bd31608359e1df30349c665674e5c35ea9a72d6/stdiomask-0.0.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-10-11 02:32:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "asweigart",
    "github_project": "stdiomask",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "stdiomask"
}