added check version instructions + extended CHANGELOG.md

daveoncode · daveoncode · commit 6d3e319b3eff · 2020-03-04T11:02:51.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,20 @@
 
 ## v1.0.0 (March 2020)
 
-### Deprecations
+### Project reboot:
+
+I realized that this project, which I started back in 2015 and I was thinking no one care about it, it's actually now
+being used by several projects on GitHub (despite it has only few stars).
+So I'm rebooting it with a brand new version with tons of new api and improvements.
+
+Besides the code, the project configuration is now mature and professional: 
+- Automatic builds and testing against multiple python versions with Travis CI
+- Automatic code coverage reporting on codecov.io
+- Automatic documentation generated on readthedocs.io
+- Better descriptions and provided examples
+
+
+### Deprecations:
 
 We are in 2020 and finally old versions of Python have been 
 [officially deprecated](https://www.python.org/doc/sunset-python-2/).
@@ -37,15 +50,15 @@ in your code (inspired by Scala)
 - `random_string()`: generates string of given size with random alpha-numeric chars
 - `secure_random_hex()`: generates hexadecimal string of the given bytes count using secure random generator
 
-### Fixes
+### Fixes:
 
 - `is_ip()` now checks both ip v4 (and validates 0-255 range) and ip v6 
 (the previous implementation was really shallow, my apologies :P)
 - `is_json()` now considers as valid json array objects (eg. `is_json('[1, 2, 3]')` returns true now)
 - `prettify()` does not screw up urls or emails anymore (from now on it won't consider those as text to be formatted)
 - Solved deprecation warnings over invalid escape sequences in Python >= 3.7 
 
-### Changes
+### Changes:
 
 - Old module `string_utils.py` has been replaced by a package with submodules (`validation.py`, `manipulation.py`, 
 `generation.py` and `errors.py`), anyway all the functions are still 
@@ -54,7 +67,7 @@ with a module for each test case
 - `is_snake_case()` now considers as "snake case" strings with mixed upper and lower case characters, strings with 
 leading or trailing underscores and string containing multiple underscores in sequence
 
-### Improvements
+### Improvements:
 
 - Added Python type hints to all functions arguments and return types 
 (this is now feasible since the minimum supported Python version is the 3.5)
@@ -69,6 +82,7 @@ signature has changed (now it has two optional boolean arguments: `ignore_spaces
 - `slugify()` is now able to translate more non-ascii chars during the string conversion 
 (it now makes use of the new extracted method `asciify()`)
 - `is_uuid()` has now a second parameter `allow_hex` that if true, considers as valid UUID hex value
+- `uuid()` has now an optional boolean parameter `as_hex` which allows to return UUID string as hex representation
 
 ---
 
diff --git a/README.md b/README.md
@@ -7,14 +7,14 @@
 [![Python 3.8](https://img.shields.io/badge/python-3.8-blue.svg)](https://www.python.org/downloads/release/python-380/)
 
 # Python String Utils
-##### Latest version: [1.0.0](https://github.com/daveoncode/python-string-utils/blob/master/CHANGELOG.md)
+##### Latest version: [1.0.0](https://github.com/daveoncode/python-string-utils/blob/master/CHANGELOG.md) (March 2020)
 
 A handy library to validate, manipulate and generate strings, which is:
 
 - Simple and "pythonic"
 - Fully documented and with examples! (html version on [readthedocs.io](https://python-string-utils.readthedocs.io/en/develop))
 - 100% code coverage! (see it with your own eyes on [codecov.io](https://codecov.io/gh/daveoncode/python-string-utils/branch/develop))
-- Tested (automatically on each push thanks to Travis CI) against all officially supported Python versions: 3.5, 3.6, 3.7, 3.8.
+- Tested (automatically on each push thanks to Travis CI) against all officially supported Python versions
 - Fast (mostly based on compiled regex)
 - Free from external dependencies
 - PEP8 complaint
@@ -46,8 +46,8 @@ can be simplified as:
 
 ### Api overview
 
-*Bear in mind: this is just an overview, 
-for the full API documentation go here:* http://python-string-utils.readthedocs.org/en/latest/
+***Bear in mind**: this is just an overview, 
+for the full API documentation see:* [readthedocs.io](https://python-string-utils.readthedocs.io/en/develop)
 
 #### String validation functions:
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,6 +18,14 @@ Installing
 >>> pip install python-string-utils
 
 
+Checking installed version
+--------------------------
+
+>>> import string_utils
+>>> string_utils.__version__
+>>> '1.0.0' # (if '1.0.0' is the installed version)
+
+
 Library structure
 -----------------
 
