xkcdpass

https://pypi.org/project/xkcdpass/
Admin
xkcdpass is a flexible and scriptable password generator which generates strong passphrases,...
Tokens:2,946
Snippets:55
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Install xkcdpass Manually

Source: https://pypi.org/project/xkcdpass

Install xkcdpass from a local source directory using pip. This is useful for development or when installing from a cloned repository.

```bash
pip install .
```

--------------------------------

### Install xkcdpass using pip

Source: https://pypi.org/project/xkcdpass

Install the xkcdpass package using pip for easy integration into your Python projects.

```bash
pip install xkcdpass
```

--------------------------------

### Display Help Message

Source: https://pypi.org/project/xkcdpass

Shows the help message and lists all available options for the xkcdpass command.

```bash
xkcdpass --help
```

--------------------------------

### Generate Password with Acrostic using xkcdpass Module

Source: https://pypi.org/project/xkcdpass

Demonstrates importing the xkcdpass module to generate a password with a specified acrostic. It shows how to locate the default wordfile, generate a wordlist with specific length constraints, and then create the password.

```python
from xkcdpass import xkcd_password as xp

# create a wordlist from the default wordfile
# use words between 5 and 8 letters long
wordfile = xp.locate_wordfile()
mywords = xp.generate_wordlist(wordfile=wordfile, min_length=5, max_length=8)

# create a password with the acrostic "face"
print(xp.generate_xkcdpassword(mywords, acrostic="face"))
```

--------------------------------

### Enable Insecure Random Number Generator via Environment Variable

Source: https://pypi.org/project/xkcdpass

Demonstrates how to enable the use of an insecure random number generator by setting an environment variable. This method is an alternative to using the command-line flag for versions 1.7.0 and later.

```bash
export XKCDPASS_ALLOW_WEAKRNG=1
```

--------------------------------

### Generate Password from Command Line

Source: https://pypi.org/project/xkcdpass

Run xkcdpass from the command line to generate a secure multiword passphrase. The output is directly printed to the console.

```bash
$ xkcdpass
> correct horse battery staple
```

--------------------------------

### Enable Insecure Random Number Generator via Command Line

Source: https://pypi.org/project/xkcdpass

Shows how to explicitly enable the use of an insecure random number generator when running the xkcdpass script from the command line. This is necessary for versions 1.7.0 and later if a cryptographically weak RNG is required.

```bash
xkcdpass --allow-weak-rng
```

--------------------------------

### xkcdpass generate_wordlist Arguments

Source: https://pypi.org/project/xkcdpass/1.30.0

Lists the arguments for the generate_wordlist function when used as an imported module. Defaults are shown.

```python
wordfile=None,
min_length=5,
max_length=9,
valid_chars='.'
```

--------------------------------

### xkcdpass generate_xkcdpassword Arguments

Source: https://pypi.org/project/xkcdpass/1.30.0

Lists the arguments for the generate_xkcdpassword function when used as an imported module. Defaults are shown.

```python
wordlist,
numwords=6,
interactive=False,
acrostic=False,
delimiter=" "
```

--------------------------------

### Generate Default Password

Source: https://pypi.org/project/xkcdpass

Generates a single password using the default dictionary and settings. No arguments are required.

```bash
$ xkcdpass
> pinball previous deprive militancy bereaved numeric
```

--------------------------------

### Generate Multiple Customized Passwords

Source: https://pypi.org/project/xkcdpass

Generates multiple passwords with specific constraints including count, acrostic, delimiter, word length, and allowed characters.

```bash
$ xkcdpass --count=5 --acrostic='chaos' --delimiter='|' --min=5 --max=6 --valid-chars='[a-z]'
> collar|highly|asset|ovoid|sultan
> caper|hangup|addle|oboist|scroll
> couple|honcho|abbot|obtain|simple
> cutler|hotly|aortae|outset|stool
> cradle|helot|axial|ordure|shale
```
Tokens:
Raw