Skip to content

Commit

Permalink
Updated readme & package
Browse files Browse the repository at this point in the history
  • Loading branch information
CodeConfidant committed Jul 24, 2020
1 parent afedb42 commit aac9aa0
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 9 deletions.
21 changes: 14 additions & 7 deletions README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,20 @@ randalpha(): Generates a random lowercase letter from the e
randspec(): Generates a random special character and returns it as a string.

randstr(string_length, seed_type): Return a string with random values of designated int length (Cap of 10000). The random value combos are selected by using a specific string for the seed_type argument.
The seed_type argument value options (not case sensitive) are as follows:
"al" - (Alphabet Lower) Random lowercase alphabet letters.
"au" - (Alphabet Upper) Random uppercase alphabet letters.
"dig" - (Digit) Random digits 0-9.
"spec" - (Special) Random special characters.
"ad" - (Alphabet Lower | Alphabet Upper | Digit) Random lowercase & uppercase alphabet letters. Random digits 0-9.
"ads" - (Alphabet Lower | Alphabet Upper | Digit | Special) Random lowercase & uppercase alphabet letters. Random digits 0-9. Random special characters.

The seed_type argument value options (not case sensitive) are as follows:

"al" - (Alphabet Lower) Random lowercase alphabet letters.

"au" - (Alphabet Upper) Random uppercase alphabet letters.

"dig" - (Digit) Random digits 0-9.

"spec" - (Special) Random special characters.

"ad" - (Alphabet Lower | Alphabet Upper | Digit) Random lowercase & uppercase alphabet letters. Random digits 0-9.

"ads" - (Alphabet Lower | Alphabet Upper | Digit | Special) Random lowercase & uppercase alphabet letters. Random digits 0-9. Random special characters.

isspec(arg): Return true if all characters in arg string are special characters.

Expand Down
Binary file removed dist/randstr-random-1.0.tar.gz
Binary file not shown.
Binary file added dist/randstr-random-1.1.tar.gz
Binary file not shown.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@

setup(
name='randstr-random',
version='1.0',
version='1.1',
py_modules=['randstr'],
license='MIT',
description='A Python package module for generating strings with random characters built on top of the random module.',
description='A Python package for generating strings with random characters built on top of the random module.',
long_description=open('README.txt').read(),
long_description_content_type='text/markdown',
url='https://github.com/CodeConfidant/randstr-random',
Expand Down

0 comments on commit aac9aa0

Please sign in to comment.