From a45c91dff6f5071434a4927753ce44958b3f3cba Mon Sep 17 00:00:00 2001
From: Rossen Georgiev <rossen@rgp.io>
Date: Sun, 3 Oct 2021 21:13:50 +0100
Subject: [PATCH] add steam.version_report + github templates

Closes #266
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 29 +++++++++++++++
 .github/ISSUE_TEMPLATE/config.yml         |  8 +++++
 .github/ISSUE_TEMPLATE/feature_request.md | 18 ++++++++++
 docs/api/steam.versions_report.rst        |  5 +++
 steam/versions_report/__init__.py         | 43 +++++++++++++++++++++++
 steam/versions_report/__main__.py         |  4 +++
 6 files changed, 107 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/config.yml
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100644 docs/api/steam.versions_report.rst
 create mode 100644 steam/versions_report/__init__.py
 create mode 100644 steam/versions_report/__main__.py

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..54894f2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,29 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug, needs-review
+assignees: ''
+
+---
+
+**Description**
+A clear and concise description of what the bug is.
+
+**Steps to Reproduce the behavior**
+(Include debug logs if possible and relevant)
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Versions Report**
+<details><summary>python -m steam.versions_report</summary>
+(Run python -m steam.versions_report and paste the output below)
+
+```yaml
+PASTE HERE
+```
+</details>
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
new file mode 100644
index 0000000..f8f801e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Ask a question in the discussion section
+    url: https://github.com/ValvePython/steamctl/discussions
+    about: Please ask and answer questions here.
+  - name: Ask a question via IRC (libera.chat)
+    url: https://web.libera.chat/#steamre
+    about: Please ask and answer questions here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..37d067b
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,18 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE REQUEST]"
+labels: feature-request, needs-review
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
diff --git a/docs/api/steam.versions_report.rst b/docs/api/steam.versions_report.rst
new file mode 100644
index 0000000..0c8e8f6
--- /dev/null
+++ b/docs/api/steam.versions_report.rst
@@ -0,0 +1,5 @@
+versions_report
+===============
+
+.. automodule:: steam.versions_report
+    :members:
diff --git a/steam/versions_report/__init__.py b/steam/versions_report/__init__.py
new file mode 100644
index 0000000..96531da
--- /dev/null
+++ b/steam/versions_report/__init__.py
@@ -0,0 +1,43 @@
+
+import sys
+
+def versions_report():
+    """Print a report of al dependacy versions, and environment"""
+
+    from steam import __version__
+    print("steam: {}".format(__version__))
+
+    # dependecy versions
+    print("\nDependencies:")
+
+    import pkg_resources
+
+    installed_pkgs = {pkg.project_name.lower(): pkg.version for pkg in pkg_resources.working_set}
+
+    for dep in [
+                "vdf",
+                "protobuf",
+                "requests",
+                "cachetools",
+                "gevent",
+                "gevent-eventemitter",
+                "pycryptodomex",
+                "enum34",
+                "win-inet-pton",
+                ]:
+        print("{:>20}: {}".format(dep, installed_pkgs.get(dep.lower(), "Not Installed")))
+
+    # python runtime
+    print("\nPython runtime:")
+    print("          executable: %s" % sys.executable)
+    print("             version: %s" % sys.version.replace('\n', ''))
+    print("            platform: %s" % sys.platform)
+
+    # system info
+    import platform
+
+    print("\nSystem info:")
+    print("              system: %s" % platform.system())
+    print("             machine: %s" % platform.machine())
+    print("             release: %s" % platform.release())
+    print("             version: %s" % platform.version())
diff --git a/steam/versions_report/__main__.py b/steam/versions_report/__main__.py
new file mode 100644
index 0000000..f61ebb2
--- /dev/null
+++ b/steam/versions_report/__main__.py
@@ -0,0 +1,4 @@
+
+if __name__ == '__main__':
+    from steam.versions_report import versions_report
+    versions_report()