Add method that show base installation info about gensim & related packages. Fix #1902

docs/src/apiref.rst

@@ -79,6 +79,7 @@ Modules:
     topic_coherence/probability_estimation
     topic_coherence/segmentation
     topic_coherence/text_analysis
+    scripts/package_info
     scripts/glove2word2vec
     scripts/make_wikicorpus
     scripts/word2vec_standalone

docs/src/scripts/package_info.rst

@@ -0,0 +1,9 @@
+:mod:`scripts.package_info` -- Information about gensim package
+===============================================================
+
+.. automodule:: gensim.scripts.package_info
+    :synopsis: Information about gensim package.
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:

gensim/__init__.py

@@ -1,8 +1,7 @@
-"""
-This package contains interfaces and functionality to compute pair-wise document
-similarities within a corpus of documents.
-"""
+"""This package contains interfaces and functionality to compute pair-wise document similarities within a corpus
+of documents.
 
+"""
 from gensim import parsing, matutils, interfaces, corpora, models, similarities, summarization, utils  # noqa:F401
 import logging
 

gensim/scripts/package_info.py

@@ -0,0 +1,60 @@
+"""Get basic information about gensim & dependencies (useful for bug-reporting).
+
+Examples
+--------
+You can use it through python
+
+>>> from gensim.scripts.package_info import package_info
+>>>
+>>> info = package_info()
+
+or using CLI interface
+
+::
+
+    python -m gensim.scripts.package_info --info
+
+
+.. program-output:: python -m gensim.scripts.package_info --help
+   :ellipsis: 0, -4
+"""
+import argparse
+import platform
+import sys
+import os
+import numpy
+import scipy
+import gensim
+from gensim.models.word2vec import FAST_VERSION
+
+
+def package_info():
+    """Get the versions of Gensim and its dependencies,
+    the location where Gensim is installed and platform on which the system is running.
+
+    Returns
+    -------
+    dict of (str, str)
+        Dictionary containing the versions of Gensim, Python, NumPy, SciPy and platform information.
+
+    """
+    return {
+        "Platform": platform.platform(),
+        "Python": sys.version.replace("\n", ', '),
+        "NumPy": numpy.__version__,
+        "SciPy": scipy.__version__,
+        "Gensim": gensim.__version__,
+        "Location": os.path.abspath(__file__),
+        "FAST_VERSION": FAST_VERSION
+    }
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description=__doc__[:-65], formatter_class=argparse.RawDescriptionHelpFormatter)
+    parser.add_argument("--info", help="Information about Gensim package", action="store_true")
+    args = parser.parse_args()
+
+    if args.info:
+        print("Gensim installation information\n")
+        for (k, v) in sorted(package_info().items()):
+            print("{}: {}".format(k, v))