Update docs

.cookietemple.yml

@@ -12,7 +12,7 @@ email: lukas.heumos@posteo.net
 project_name: system-intelligence
 project_short_description: Query your system for all hardware and software related
   information.
-version: 2.0.0
+version: 2.0.1
 license: Apache2.0
 command_line_interface: Click
 testing_library: pytest

CHANGELOG.rst

@@ -5,6 +5,22 @@ Changelog
 This project adheres to `Semantic Versioning <https://semver.org/>`_.
 
 
+2.0.1 (2021-01-03)
+------------------
+
+**Added**
+
+* Updated documentation
+
+* Updated PyPi classifiers
+
+**Fixed**
+
+**Dependencies**
+
+**Deprecated**
+
+
 2.0.0 (2021-01-03)
 ------------------
 

cookietemple.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.0.0
+current_version = 2.0.1
 
 [bumpversion_files_whitelisted]
 setup_file = setup.py

docs/conf.py

@@ -56,9 +56,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = '2.0.0'
+version = '2.0.1'
 # The full version, including alpha/beta/rc tags.
-release = '2.0.0'
+release = '2.0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/installation.rst

@@ -4,9 +4,7 @@
 Installation
 ============
 
-Please note that system-intelligence currently only offers support for Linux.
-It will very likely also work well on MacOS, but it is unlikely to work on Windows.
-If you want to improve the Windows support please get in touch.
+System-intelligence supports all three major platforms: Linux, MacOS and Windows
 
 Stable release
 --------------
@@ -37,18 +35,11 @@ You can either clone the public repository:
 
     $ git clone git://github.com/mlf-core/system-intelligence
 
-Or download the `tarball`_:
+Once you have a copy of the source and are in the top level directory, you can install it with:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/mlf-core/system-intelligence/tarball/master
-
-Once you have a copy of the source, you can install it with:
-
-.. code-block:: console
-
-    $ python setup.py install
+    $ pip install .
 
 
 .. _Github repo: https://github.com/mlfcore/system-intelligence
-.. _tarball: https://github.com/mlfcore/system-intelligence/tarball/master

docs/usage.rst

@@ -35,13 +35,59 @@ As an example you may run
 
     $ system-intelligence all --output_format json --output info.json
 
+As of version 2.0.0, you can also run queries by querying all scopes except for some of them.
+An example, where one queries every scope except RAM and Software, would look like the following:
+
+.. code-block:: console
+
+    $ system-intelligence -e ram software
+
 To suppress the standard output you may add the option
 
 .. code-block:: console
 
     $ system_intelligence <scope> --silent
 
 
+System-intelligence on MacOS
+----------------------------
+As with version 2.0.0, system-intelligence can also query under MacOS. However,
+there are a few peculiarities:
+
+1.) Querying host will also display the model marketing name of the users device (if available)
+
+2.) As RAM info on MacOS is limited compared to Linux or Windows, the RAM query will only display
+Slot, Type, Size, Speed and Serial Number of each RAM slot as well as the total memory size
+
+3.) There is no need to run it with sudo, since it's not required like in Linux for example
+
+4.) All memory size units (so every Byte unit) is displayed using base10, as this is 'Darwin's' way to compute such units
+
+5.) The L1 Cache in the CPU query summarizes the L1i cache and the L1d cache together
+
+System-intelligence on Windows
+------------------------------
+As with version 2.0.0, system-intelligence can also query under Windows. There are only a few minor things different to whats displayed under linux:
+
+1.) L1 CPU cache size is not available (as for now) and thus will be not displayed
+
+2.) Size units (bytes basically) are displayed using base2 computation as this is how Windows computes those numbers
+
+Generate HTML report
+--------------------
+System-intelligence can not only print the results to stdout, but is also capable of creating nice HTML reports that can be included in your research or appliaction.
+To generate such report in a file called result.html above the current working directory simply run the following:
+
+.. code-block:: console
+
+    $ system_intelligence all -f json -g -o result.html
+
+Note, that under Windows, this must be:
+
+.. code-block:: console
+
+    $ system_intelligence all -f json -g -o result.html
+
 Module
 ---------
 

setup.py

@@ -39,17 +39,18 @@ def walker(base, *paths):
 setup(
     author="Lukas Heumos",
     author_email='lukas.heumos@posteo.net',
-    python_requires='>=3.5',
     classifiers=[
-        'Development Status :: 2 - Pre-Alpha',
+        'Development Status :: 5 - Production/Stable',
         'Intended Audience :: Developers',
         'License :: OSI Approved :: Apache Software License',
         'Natural Language :: English',
         'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.5',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Operating System :: Microsoft :: Windows :: Windows 10',
+        'Operating System :: MacOS :: MacOS X',
+        'Operating System :: POSIX :: Linux'
     ],
     description="Query your system for all hardware and software related information.",
     entry_points={
@@ -74,6 +75,6 @@ def walker(base, *paths):
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/zethson/system_intelligence',
-    version='2.0.0',
+    version='2.0.1',
     zip_safe=False,
 )

system_intelligence/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Lukas Heumos"""
 __email__ = 'lukas.heumos@posteo.net'
-__version__ = '2.0.0'
+__version__ = '2.0.1'