Skip to content

Commit

Permalink
add steam.version_report + github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
rossengeorgiev committed Oct 3, 2021
1 parent 107ef80 commit a45c91d
Show file tree
Hide file tree
Showing 6 changed files with 107 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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>
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.

5 changes: 5 additions & 0 deletions docs/api/steam.versions_report.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
versions_report
===============

.. automodule:: steam.versions_report
:members:
43 changes: 43 additions & 0 deletions steam/versions_report/__init__.py
Original file line number Diff line number Diff line change
@@ -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())
4 changes: 4 additions & 0 deletions steam/versions_report/__main__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@

if __name__ == '__main__':
from steam.versions_report import versions_report
versions_report()

0 comments on commit a45c91d

Please sign in to comment.