[ENHANCEMENT] General info updated

- General info updated
- updating the current version in the app

Author: waldirio

README.md

@@ -8,12 +8,13 @@ This project contains the `crhc` command line tool that simplifies the use of th
 <br>
 
 **crhc-cli** will work on those versions of python:
-- 3.6
-- 3.7
-- 3.8
-- 3.9
+- 3.6+
 <br>
 
+**Supported Platforms**: At this moment supporting `Linux` and `MS Windows`.
+<br><br><br>
+
+
 Documentation is on [Read the Docs](https://crhc-cli.readthedocs.io). Code repository and issue tracker are on [GitHub](https://github.com/C-RH-C/crhc-cli/).
 
 ---

conf/conf.py

@@ -10,7 +10,7 @@
 
 
 # Current Version
-CURRENT_VERSION = "1.9.9"
+CURRENT_VERSION = "1.10.10"
 
 #  Some file references
 

docs/changelog.rst

@@ -1,6 +1,42 @@
 Changelog
 ---------
 
+**v1.10.10 - 03/25/2022**
+
+- [ENHANCEMENT] Fixing linters warnings - [`issue 97`_]
+- [ENHANCEMENT] Updating end to end test - [`issue 156`_]
+- [FIX] #118 - Fixing the api endpoint list - [`issue 118`_]
+- [ENHANCEMENT] Removing the square brackets and single quotations marks from installed product - [`issue 152`_]
+- [FIX] fixing the kvm dup entries - [`issue 40`_]
+
+.. _issue 97: https://github.com/C-RH-C/crhc-cli/issues/97
+.. _issue 156: https://github.com/C-RH-C/crhc-cli/issues/156
+.. _issue 118: https://github.com/C-RH-C/crhc-cli/issues/118
+.. _issue 152: https://github.com/C-RH-C/crhc-cli/issues/152
+.. _issue 40: https://github.com/C-RH-C/crhc-cli/issues/40
+
+
+
+**v1.9.9 - 03/01/2022**
+
+- [FIX] Issue when exporting the advisory data - [`issue 149`_]
+- [FIX] test updated - [`issue 147`_]
+- [ENHANCEMENT] MS version added
+- [ENHANCEMENT] Total # of entries added to swatch list_all - [`issue 135`_]
+- [ENHANCEMENT] Fixed the time to check for a new version - [`issue 127`_]
+- [FIX] Fixing some issues when generating the ts dump - [`issue 136`_]
+- [ENHANCEMENT] Adding the GPL 3 license - [`issue 134`_]
+- [ENHANCEMENT] fix readme links
+- [ENHANCEMENT] some update in the documentation
+- [ENHANCEMENT] end to end test added
+
+.. _issue 149: https://github.com/C-RH-C/crhc-cli/issues/149
+.. _issue 147: https://github.com/C-RH-C/crhc-cli/issues/147
+.. _issue 135: https://github.com/C-RH-C/crhc-cli/issues/135
+.. _issue 127: https://github.com/C-RH-C/crhc-cli/issues/127
+.. _issue 136: https://github.com/C-RH-C/crhc-cli/issues/136
+.. _issue 134: https://github.com/C-RH-C/crhc-cli/pull/134
+
 
 **v1.8.8 - 11/06/2021**
 

docs/conf.py

@@ -15,7 +15,7 @@
 #
 import os
 import sys
-from conf import conf
+# from conf import conf
 sys.path.insert(0, os.path.abspath('..'))
 
 
@@ -28,8 +28,8 @@
 # The full version, including alpha/beta/rc tags
 
 # Pointing to the current conf file with the app version
-# release = '1.7.7'
-release = conf.CURRENT_VERSION
+release = '1.10.10'
+# release = conf.CURRENT_VERSION
 
 
 # -- General configuration ---------------------------------------------------

docs/features.rst

@@ -9,11 +9,12 @@ In this section you can see all the available features in ``crhc-cli``
 * Export of Advisor data, in ``JSON`` and ``CSV`` format.
 * Export of Vulnerability data, in ``JSON`` and ``CSV`` format.
 * Export of Patch data, in ``JSON`` and ``CSV`` format.
-* Subscription Socket summary (spliting hypervisors from VM's).
-* Present the list of API endpoints.
+* Subscription Socket summary (spliting the sockets from hypervisors and VM's with no host-guest mapping).
+* Easy way to present the available API endpoints.
 * Easy way to consume the API endpoints listed above.
-* Access Token generation to be used with 3rd party software, for example ``curl``. ``$(./crhc token)`` 
-* Export the whole information easily ``./crhc ts dump`` to help the ``Red Hat Support team`` during the troubleshooting process.
+* Access Token generation to be used with 3rd party software, for example ``curl -H 'Authorization: Bearer $(./crhc token) ...'`` 
+* Currently supporting both platforms, ``Linux`` and ``MS Windows`` with python 3.6+
+* Export the whole information easily via ``./crhc ts dump`` to help the ``Red Hat Support team`` during the troubleshooting process.
 
 Are you looking for something new that is not listed above? Click `here`_ and let us know.
 

docs/modules.rst

@@ -4,12 +4,12 @@ crhc-cli
 .. toctree::
    :maxdepth: 4
 
-   crhc
-   parse
    conf
    credential
+   crhc
    execution
    help
+   parse
    report
    tests
    troubleshoot