Skip to main content

HelpDev - Information collector to help users and developers when reporting

Project description

Helping users and developers to get information about the environment to report bugs or even test your system without spending a day in it.

It can get information about hardware, OS, Python distribution and packages, including Qt-things. Operates in Linux, Windows and Mac.

If you want to get information at runtime of your application, so you need to call using the same environment (and process) in which your application is running.

This module can be imported and integrated into your application, providing a report about the current environment.

To install or update, do

$ pip install -U helpdev

To run from terminal

$ helpdev

To remove

$ pip uninstall helpdev

To get some help information

$ helpdev --help

Help output

usage: helpdev [-h] [--hardware] [--os] [--float] [--int] [--network]
            [--timeout TIMEOUT] [--python] [--conda] [--python-packages]
            [--python-packages-e] [--conda-packages] [--conda-packages-e]
            [--qt] [--path] [--scope] [--all] [--sure-all]


optional arguments:
-h, --help           show this help message and exit
--hardware           CPU, memory and architecture (PEI) (default: False)
--os                 Operating system (PEI) (default: False)
--float              Float representation in the system (PEI) (default: False)
--int                Integer representation in the system (PEI) (default: False)
--network            Network information, DNS and load for usual sites (PEI) (default: False)
--timeout TIMEOUT    Connection test timeout threshold, 0 to disable (Option) (default: 10)


--python             Python distribution (PED) (default: False)
--conda              Conda/Anaconda Python distribution (PED) (default: False)
--qt                 All about Qt, abstractions (QtPy/Qt.Py/PyQtGraph), bindings (PyQt/PySide) and Qt (C++)(PEAD) (default: False)


--python-packages    PIP installed packages + PIP check (PED) (default: False)
--python-packages-e  PIP locally installed packages + PIP check (PED) (default: False)
--conda-packages     CONDA installed packages (PED) (default: False)
--conda-packages-e   CONDA locally installed packages (PED) (default: False)


--path               Show Python current paths i.e. sys.path (PEAD) (default: False)
--scope              Show Python current scope i.e. dir() (PEAD) (default: False)
--all                Run all options, except 'path' and 'scope'(PEAD) (default: False)
--sure-all           Run all options, INCLUDING 'path' and 'scope', personal
                    folder paths and information (PEAD) (default: False)

Using --all (no personal information)

$ helpdev --all

Example of output

* HARDWARE------------------------------------------------------------------------------------------------------
    - Machine....................... x86_64
    - Processor..................... Intel(R) Core(TM) i7-4790K CPU @ 4.00GHz
    - Memory........................ 16689 MB
    - Used memory................... 8569 MB
* OPERATING SYSTEM----------------------------------------------------------------------------------------------
    - System........................ Linux
    - Release....................... 4.15.0-47-generic
    - Platform...................... Linux-4.15.0-47-generic-x86_64-with-debian-buster-sid
    - Version....................... #50-Ubuntu SMP Wed Mar 13 10:44:52 UTC 2019
* FLOAT---------------------------------------------------------------------------------------------------------
    - Epsilon....................... 2.220446049250313e-16
    - Digits........................ 15
    - Precision..................... 53
    - Maximum....................... 1.7976931348623157e+308
    - Maximum Exp................... 1024
    - Max. 10 Exp................... 308
    - Minimum....................... 2.2250738585072014e-308
    - Miminim Exp................... -1021
    - Min. 10 Exp................... -307
    - Radix......................... 2
    - Rounds........................ 1
* INTEGER-------------------------------------------------------------------------------------------------------
    - Bits per Digit................ 30
    - Size of Digit................. 4
* NETWORK-------------------------------------------------------------------------------------------------------
    - Timeout....................... 10
    - PyPI.......................... DNS: 0.0151s LOAD: 0.6666s URL: https://pypi.python.org/pypi/pip
    - Conda......................... DNS: 0.0316s LOAD: 0.1000s URL: https://repo.continuum.io/pkgs/free/
    - GitLab........................ DNS: 0.0019s LOAD: 0.9430s URL: https://gitlab.com
    - GitHub........................ DNS: 0.0018s LOAD: 0.5405s URL: https://github.com
    - Google........................ DNS: 0.0038s LOAD: 0.3536s URL: https://google.com
* PYTHON DISTRIBUTION-------------------------------------------------------------------------------------------
    - Version....................... 3.6.8
    - Compiler...................... GCC 7.3.0
    - Build......................... default of Dec 30 2018 01:22:34
    - Implem........................ CPython
    - API........................... 1013
* CONDA DISTRIBUTION--------------------------------------------------------------------------------------------
    - Version....................... 4.6.12
    - Build......................... 3.17.8
    - Python........................ 3.7.3.final.0
* QT ABSTRACTIONS-----------------------------------------------------------------------------------------------
    - qtpy Version.................. 1.7.0
    - qtpy Binding.................. pyqt5
    - pyqtgraph Version............. 0.10.0
    - pyqtgraph Binding............. Not set or inexistent
    - Qt Version.................... 1.1.0
    - Qt Binding.................... PySide2
* QT BINDINGS---------------------------------------------------------------------------------------------------
    - PyQt5 Version................. 5.12.1
    - PyQt5 Qt Version.............. 5.12.2
    - PySide2 Version............... 5.12.2
    - PySide2 Qt Version............ 5.12.2
* PYTHON PACKAGES (pip list)------------------------------------------------------------------------------------
    - alabaster..................... 0.7.12
    - appdirs....................... 1.4.3
    - asn1crypto.................... 0.24.0
    - aspy.yaml..................... 1.2.0
    - astroid....................... 2.2.5
    - atomicwrites.................. 1.3.0
    - attrs......................... 19.1.0
    - autopep8...................... 1.4.4
    - Babel......................... 2.6.0
    - backcall...................... 0.1.0
    - bandit........................ 1.5.1
    - bleach........................ 3.1.0
    - certifi....................... 2019.3.9
    - cffi.......................... 1.12.2
    - cfgv.......................... 1.6.0
    - chardet....................... 3.0.4
    - ciermag-spec.................. 0.2
    - ciermag-spec2................. 2.1
    - Click......................... 7.0
    - click-completion.............. 0.5.1
    - cloudpickle................... 0.8.1
    - colorama...................... 0.4.1
    - coverage...................... 4.5.3
    - crayons....................... 0.2.0
    - cryptography.................. 2.6.1
    - cycler........................ 0.10.0
    - decorator..................... 4.4.0
    - defusedxml.................... 0.5.0
    - doc8.......................... 0.8.0
    - docformatter.................. 1.1
    - docutils...................... 0.14
    - dparse........................ 0.4.1
    - entrypoints................... 0.3
    - eradicate..................... 1.0
    - filelock...................... 3.0.10
    - flake8........................ 3.7.7
    - flake8-polyfill............... 1.0.2
    - gitdb2........................ 2.0.5
    - GitPython..................... 2.1.11
    - h5py.......................... 2.9.0
    - helpdev....................... 0.1
    - identify...................... 1.4.1
    - idna.......................... 2.8
    - imagesize..................... 1.1.0
    - importlib-metadata............ 0.9
    - importlib-resources........... 1.0.2
    - ipykernel..................... 5.1.0
    - ipython....................... 7.4.0
    - ipython-genutils.............. 0.2.0
    - isort......................... 4.3.17
    - jedi.......................... 0.13.3
    - jeepney....................... 0.4
    - Jinja2........................ 2.10.1
    - jsonpickle.................... 1.1
    - jsonschema.................... 3.0.1
    - jupyter-client................ 5.2.4
    - jupyter-core.................. 4.4.0
    - keyring....................... 19.0.1
    - kiwisolver.................... 1.0.1
    - latexcodec.................... 1.0.6
    - lazy-object-proxy............. 1.3.1
    - lml........................... 0.0.9
    - lxml.......................... 4.3.3
    - mando......................... 0.6.4
    - MarkupSafe.................... 1.1.1
    - matplotlib.................... 3.0.3
    - mccabe........................ 0.6.1
    - mistune....................... 0.8.4
    - more-itertools................ 7.0.0
    - mpmath........................ 1.1.0
    - nbconvert..................... 5.4.1
    - nbformat...................... 4.4.0
    - networkx...................... 2.3
    - nodeenv....................... 1.3.3
    - numpy......................... 1.16.2
    - numpydoc...................... 0.8.0
    - oset.......................... 0.1.3
    - packaging..................... 19.0
    - pandocfilters................. 1.4.2
    - parso......................... 0.4.0
    - pbr........................... 5.1.3
    - pexpect....................... 4.7.0
    - pickleshare................... 0.7.5
    - Pint.......................... 0.9
    - pip........................... 19.0.3
    - pipdate....................... 0.3.2
    - pipdeptree.................... 0.13.2
    - pluggy........................ 0.9.0
    - pre-commit.................... 1.15.1
    - prescription.................. 0.2
    - prompt-toolkit................ 2.0.9
    - psutil........................ 5.6.1
    - ptyprocess.................... 0.6.0
    - py............................ 1.8.0
    - pybtex........................ 0.22.2
    - pybtex-docutils............... 0.2.1
    - pycodestyle................... 2.5.0
    - pycparser..................... 2.19
    - pycycle....................... 0.0.8
    - pydicom....................... 1.2.2
    - pydocstyle.................... 3.0.0
    - pyexcel....................... 0.5.13
    - pyexcel-handsontable.......... 0.0.2
    - pyexcel-io.................... 0.5.17
    - pyexcel-odsr.................. 0.5.2
    - pyexcel-xls................... 0.5.8
    - pyflakes...................... 2.1.1
    - pyftpdlib..................... 1.5.5
    - Pygments...................... 2.3.1
    - pylama........................ 7.7.1
    - pylint........................ 2.3.1
    - pymr.......................... 0.45
    - pymr2......................... 2.5
    - PyOpenGL...................... 3.1.0
    - pyparsing..................... 2.4.0
    - PyQt5......................... 5.12.1
    - PyQt5-sip..................... 4.19.15
    - pyqtgraph..................... 0.10.0
    - PyQtWebEngine................. 5.12.1
    - pyrsistent.................... 0.14.11
    - PySide2....................... 5.12.2
    - pytest........................ 4.4.1
    - pytest-cov.................... 2.6.1
    - pytest-qt..................... 3.2.2
    - python-dateutil............... 2.8.0
    - pytz.......................... 2019.1
    - pyusb......................... 1.0.2
    - PyYAML........................ 5.1
    - pyzmq......................... 18.0.1
    - QDarkStyle.................... 2.6.5
    - Qt.py......................... 1.1.0
    - QtAwesome..................... 0.5.7
    - qtconsole..................... 4.4.3
    - QtPy.......................... 1.7.0
    - radon......................... 3.0.1
    - requests...................... 2.21.0
    - restructuredtext-lint......... 1.3.0
    - rope.......................... 0.14.0
    - safety........................ 1.8.5
    - scipy......................... 1.2.1
    - scspell3k..................... 2.2
    - SecretStorage................. 3.1.1
    - setuptools.................... 40.8.0
    - shellingham................... 1.3.1
    - shiboken2..................... 5.12.2
    - six........................... 1.12.0
    - smmap2........................ 2.0.5
    - snowballstemmer............... 1.2.1
    - Sphinx........................ 2.0.1
    - sphinx-rtd-theme.............. 0.4.3
    - sphinxcontrib-applehelp....... 1.0.1
    - sphinxcontrib-bibtex.......... 0.4.2
    - sphinxcontrib-devhelp......... 1.0.1
    - sphinxcontrib-excel........... 0.0.1
    - sphinxcontrib-fulltoc......... 1.2.0
    - sphinxcontrib-htmlhelp........ 1.0.2
    - sphinxcontrib-jsmath.......... 1.0.1
    - sphinxcontrib-plantuml........ 0.15
    - sphinxcontrib-qthelp.......... 1.0.2
    - sphinxcontrib-serializinghtml. 1.1.3
    - spyder........................ 3.3.4
    - spyder-kernels................ 0.4.3
    - spyder-pymr................... 0.2
    - spyder-pymr2.................. 2.1
    - stevedore..................... 1.30.1
    - sympy......................... 1.4
    - termcolor..................... 1.1.0
    - testpath...................... 0.4.2
    - texttable..................... 1.6.1
    - toml.......................... 0.10.0
    - torm-console.................. 1.4
    - torm-ide...................... 1.22
    - torm-processing............... 0.11
    - tornado....................... 6.0.2
    - tox........................... 3.8.6
    - traitlets..................... 4.3.2
    - typed-ast..................... 1.3.1
    - untokenize.................... 0.1.1
    - urllib3....................... 1.24.1
    - virtualenv.................... 16.4.3
    - wcwidth....................... 0.1.7
    - webencodings.................. 0.5.1
    - wheel......................... 0.33.1
    - wrapt......................... 1.11.1
    - wurlitzer..................... 1.0.2
    - xlrd.......................... 1.2.0
    - xlwt.......................... 1.3.0
    - zipp.......................... 0.3.3
* CONDA PACKAGES (conda)----------------------------------------------------------------------------------------

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

helpdev-0.1.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

helpdev-0.1-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file helpdev-0.1.tar.gz.

File metadata

  • Download URL: helpdev-0.1.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for helpdev-0.1.tar.gz
Algorithm Hash digest
SHA256 4d1b7dfacaf965bb917bee8c69eb65807ac12104007641852ac18cfcba58ded7
MD5 f916d7221248d9ac595294e0dfc7773e
BLAKE2b-256 53113105af86605b7924bc5d34f4833b035908c67af54877f5175aedd2a14a33

See more details on using hashes here.

File details

Details for the file helpdev-0.1-py3-none-any.whl.

File metadata

  • Download URL: helpdev-0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8

File hashes

Hashes for helpdev-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b662cd20e092190c4a2d9cecd8d8e2ab748878d044b7f81c7b15738c9434ca2
MD5 eba2ea0d5a3c0ec30776157fb95db823
BLAKE2b-256 a07e5563c21652d02764ad3b46e9463911789759730ec35f6b492a73829962ce

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page