Metadata-Version: 2.0
Name: system-query
Version: 0.1.0.dev0
Summary: comprehensive and concise system information querying tool
Home-page: http://mbdev.pl/
Author: Mateusz Bysiek
Author-email: mb@mbdev.pl
License: Apache License 2.0
Download-URL: https://github.com/mbdevpl/system-query
Keywords: system,software,hardware
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Education
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Requires-Dist: cpuinfo
Requires-Dist: psutil
Provides-Extra: gpu
Requires-Dist: pycuda; extra == 'gpu'

.. role:: bash(code)
   :language: bash

.. role:: python(code)
   :language: python

============
system_query
============

Comprehensive and concise system information tool.

Usable as library and as a commandline tool.

as library
----------

.. code:: python

    In [1]: from system_query import query_cpu
            query_cpu()

    Out[1]: {'brand': 'Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz',
             'clock': 1771.0370000000003,
             'clock_max': 3900.0,
             'clock_min': 1600.0,
             'logical_cores': 8,
             'physical_cores': 4}

More examples in :bash:`examples.ipynb`.


as commandline tool
-------------------

For example:

.. code:: bash

    $ python3 -m system_query
    {'cpu': {'brand': 'Intel(R) Core(TM) i7-3770K CPU @ 3.50GHz',
             'clock': 1736.1565,
             'clock_max': 3900.0,
             'clock_min': 1600.0,
             'logical_cores': 8,
             'physical_cores': 4},
     'gpus': [{'brand': 'GeForce GTX 580',
               'clock': 1544000,
               'cores': 512,
               'cuda_version': 2.0,
               'memory': 1543766016,
               'memory_clock': 2004000,
               'multiprocessors': 16,
               'warp_size': 32}],
     'host': 'mbLab',
     'os': 'Linux-4.4.0-78-generic-x86_64-with-debian-stretch-sid',
     'ram': {'banks': [], 'total': 33701339136},
     'swap': 0}

Usage information:

.. code:: bash

    $ python3 -m system_query -h
    usage: system_query [-h] [-s {all,cpu,gpu,ram}] [-f {raw,json}] [-t TARGET]
                        [--version]

    Comprehensive and concise system information tool. Query a given hardware
    and/or softawre scope of your system and get results in human- and machine-
    readable formats.

    optional arguments:
      -h, --help            show this help message and exit
      -s {all,cpu,gpu,ram}, --scope {all,cpu,gpu,ram}
                            Scope of the query (default: all)
      -f {raw,json}, --format {raw,json}
                            Format of the results of the query. (default: raw)
      -t TARGET, --target TARGET
                            File path where to write the results of the query.
                            Special values: "stdout" and "stderr" to write to
                            stdout and stderr, respectively. (default: stdout)
      --version             show program's version number and exit

    Copyright 2017 by Mateusz Bysiek, Apache License 2.0,
    https://github.com/mbdevpl/system-query


