99#Python String Utils
1010#####Latest version:[ 1.0.0] ( (https://github.com/daveoncode/python-string-utils/blob/master/CHANGELOG.md) )
1111
12- An handy library to validate, manipulate and generate strings, which is:
12+ A handy library to validate, manipulate and generate strings, which is:
1313
1414- Simple and "pythonic"
1515- Fully documented!
@@ -24,16 +24,17 @@ An handy library to validate, manipulate and generate strings, which is:
2424
2525###Library structure
2626
27- The libraryis basicallya python package` string_utils ` , containing the following modules:
27+ The library basicallyconsists in the python package` string_utils ` , containing the following modules:
2828
2929- ` validation.py ` (contains string check api)
3030- ` manipulation.py ` (contains string transformation api)
3131- ` generation.py ` (contains string generation api)
3232- ` errors.py ` (contains library-specific errors)
3333- ` _regex.py ` (contains compiled regex** FOR INTERNAL USAGE ONLY** )
3434
35- plus a secondary package` tests ` which includes several submodules, specifically one for each test suite and named according to
36- the api to test (eg. tests for` is_ip() ` will be in` test_is_ip.py ` and so on)
35+ Plus a secondary package` tests ` which includes several submodules.\
36+ Specifically one for each test suite and named according to the api to test (eg. tests for` is_ip() `
37+ will be in` test_is_ip.py ` and so on)
3738
3839###Api overview
3940
@@ -234,7 +235,8 @@ prettify(' unprettified string ,, like this one,will be"prettified" .it\' s awes
234235
235236** asciify** : Converts all non-ascii chars contained in a string into the closest possible ascii representation
236237~~~~
237- asciify('èéùúòóäåëýñÅÀÁÇÌÍÑÓË') # returns 'eeuuooaaeynAAACIINOE' (string is deliberately dumb in order to show char conversion)
238+ asciify('èéùúòóäåëýñÅÀÁÇÌÍÑÓË')
239+ # returns 'eeuuooaaeynAAACIINOE' (string is deliberately dumb in order to show char conversion)
238240~~~~
239241
240242** slugify** : Convert a string into formatted slug
@@ -286,7 +288,7 @@ roman_encode(37) # returns 'XXXVII'
286288roman_decode('XXXVII') # returns 37
287289~~~~
288290
289- **roman_range**: Generator which returns roman numbers on each iteration
291+ **roman_range**: Generator which returns roman numbers on each iteration (perhaps one of the most funny api)
290292~~~~
291293for n in roman_range(10): print(n) # prints: I, II, III, IV, V, VI, VII, VIII, IX, X
292294~~~~
@@ -296,6 +298,7 @@ for n in roman_range(10): print(n) # prints: I, II, III, IV, V, VI, VII, VIII, I
296298**uuid**: Returns the string representation of a newly created UUID object
297299~~~~
298300uuid() # possible output: 'ce2cd4ee-83de-46f6-a054-5ee4ddae1582'
301+ uuid(as_hex=True) # possible output: 'ce2cd4ee83de46f6a0545ee4ddae1582'
299302~~~~
300303
301304**random_string**: Creates a string of the specified size with random chars