steam-editor-tools 0.1.0__tar.gz

steam_editor_tools-0.1.0/.flake8

@@ -0,0 +1,13 @@
+[flake8]
+# Recommend matching the black line length (default 88),
+# rather than using the flake8 default of 79:
+max-line-length = 88
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203, E501, W503, E701, E704
+exclude =
+    ./deps
+    ./inst
+    ./man
+    ./docs
+    ./alpha-*.py

steam_editor_tools-0.1.0/.gitattributes

@@ -0,0 +1,21 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.sh text eol=lf
+*.bash text eol=lf
+/Dockerfile text eol=lf
+*.cmd text eol=crlf
+*.bat text eol=crlf
+*.txt text eol=lf
+*.svg text eol=lf
+*.json text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.webp binary
+*.ico binary
+*.pdf binary
+*.xls binary
+*.xlsx binary

steam_editor_tools-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,89 @@
+name: Bug report
+description: Something is not working correctly.
+title: "[BUG]"
+labels:
+  - bug
+  - to be solved
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Get started
+      options:
+        - label: >-
+            I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: >-
+            I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+          required: true
+        - label: >-
+            I have confirmed that my issue is not duplicated with an existing issue.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: >-
+        A clear and concise description of what the bug is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: To Reproduce
+      description: >-
+        Steps to reproduce the behavior. Instead of describing the steps, you could also provide your codes related to the error here.
+      value: |
+        1. Get package from '...'
+        2. Then run '...'
+        3. An error occurs.
+
+  - type: textarea
+    attributes:
+      label: Traceback
+      description: >-
+        The python traceback of the bug. If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
+      render: bash
+
+  - type: textarea
+    attributes:
+      label: Behaviors
+      description: >-
+        If there is no traceback, please describe (1) The expected behaviors. (2) The actual behaviors.
+      value: |
+        1. The expected behaviors:
+        2. The actual behaviors:
+
+  - type: textarea
+    attributes:
+      label: Screenshots
+      description: >-
+        If applicable, add screenshots to help explain your problem.
+
+  - type: input
+    attributes:
+      label: OS
+      description: >-
+        e.g. Ubuntu 24.04, Debian 13, Windows 11 25H2
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Python version
+      description: >-
+        e.g. 3.14
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Steam Editor Tools version
+      description: >-
+        e.g. 0.1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/ISSUE_TEMPLATE/docs_request.yml

@@ -0,0 +1,47 @@
+name: Docs request
+description: Report a problem or a request for the docs.
+title: "[Docs]"
+labels:
+  - documentation
+  - to be solved
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Get started
+      options:
+        - label: >-
+            I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: >-
+            I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+          required: true
+        - label: >-
+            I have confirmed that my issue is not duplicated with an existing issue.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Problem
+      description: >-
+        If you meet any problems with the documentation, please describe your problems here.
+
+  - type: textarea
+    attributes:
+      label: Required feature
+      description: >-
+        If you need more explanations in the documentation, please describe your needs here.
+
+  - type: input
+    attributes:
+      label: Steam Editor Tools version
+      description: >-
+        e.g. 0.1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,55 @@
+name: Feature request
+description: Suggest an idea for this project
+title: "[Feature]"
+labels:
+  - enhancement
+  - to be solved
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Get started
+      options:
+        - label: >-
+            I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: >-
+            I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+          required: true
+        - label: >-
+            I have confirmed that my issue is not duplicated with an existing issue.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Problem
+      description: >-
+        If your feature request is related to a problem, please describe the problem clearly and concisely.
+
+  - type: textarea
+    attributes:
+      label: Required feature
+      description: >-
+        A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternative solution
+      description: >-
+        A clear and concise description of any alternative solutions or features you've considered.
+
+  - type: input
+    attributes:
+      label: Steam Editor Tools version
+      description: >-
+        e.g. 0.1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,33 @@
+# Pull request
+
+## Get started
+
+- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
+- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
+
+## Description
+
+Describe what you have done with this PR. List any dependencies that are required for this change.
+
+If your PR is designed for an issue, please refer to the issue by the following example:
+
+Fixes # (issue)
+
+## Updated report
+
+Please summarize your modifications as an itemized report.
+
+1. Update ...
+2. Add ...
+
+## Information
+
+Please provide the following information about your PR:
+
+- Steam Editor Tools version:
+
+## Additional context
+
+Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/PULL_REQUEST_TEMPLATE/pull_request_template.yml

@@ -0,0 +1,50 @@
+name: Pull request
+description: Send a pull request (PR) for this project.
+title: "[PR]"
+
+body:
+  - type: checkboxes
+    attributes:
+      label: Get started
+      options:
+        - label: >-
+            I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+          required: true
+        - label: >-
+            I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+          required: true
+        - label: >-
+            I have confirmed that my pull request (PR) is not duplicated with an existing PR.
+          required: true
+        - label: >-
+            I have confirmed that my pull request (PR) passes the testing workflow of the project.
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: >-
+        Describe what you have done with this PR.
+
+  - type: textarea
+    attributes:
+      label: Updated report
+      description: >-
+        Summarize your modifications as itemized report.
+      value: |
+        1. Update ...
+        2. Add ...
+
+  - type: input
+    attributes:
+      label: Steam Editor Tools version
+      description: >-
+        e.g. 0.1.x
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,33 @@
+# Pull request
+
+## Get started
+
+- [ ] I have read [Contributing guidelines](https://github.com/cainmagi/steam-editor-tools/blob/main/CONTRIBUTING.md).
+- [ ] I agree to follow the [Code of Conduct](https://github.com/cainmagi/steam-editor-tools/blob/main/CODE_OF_CONDUCT.md).
+- [ ] I have confirmed that my pull request (PR) is not duplicated with an existing PR.
+- [ ] I have confirmed that my pull request (PR) passes the testing workflow of the project.
+
+## Description
+
+Describe what you have done with this PR. List any dependencies that are required for this change.
+
+If your PR is designed for an issue, please refer to the issue by the following example:
+
+Fixes # (issue)
+
+## Updated report
+
+Please summarize your modifications as an itemized report.
+
+1. Update ...
+2. Add ...
+
+## Information
+
+Please provide the following information about your PR:
+
+- Steam Editor Tools version:
+
+## Additional context
+
+Add any other context about the problem here.

steam_editor_tools-0.1.0/.github/workflows/python-package.yml

@@ -0,0 +1,39 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Python package
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install flake8 pytest wheel
+          python -m pip install -r requirements.txt -r tests/requirements.txt
+      - name: Lint with flake8
+        run: |
+          # stop the build if there are Python syntax errors or undefined names
+          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+          flake8 . --count --exit-zero --max-complexity=50 --ignore=E203,E501,W503,E701,E704 --statistics
+      - name: Test with pytest
+        run: |
+          python -m pytest

steam_editor_tools-0.1.0/.github/workflows/python-publish.yml

@@ -0,0 +1,42 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build wheel
+          if [ -f requirements.txt ]; then python -m pip install -r requirements.txt; fi
+      - name: Build package
+        run: python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

steam_editor_tools-0.1.0/.gitignore

@@ -0,0 +1,249 @@
+# Created by .ignore support plugin (hsz.mobi)
+### Webpack
+.build_cache
+### VisualStudioCode template
+.vscode/*
+# !.vscode/settings.json
+# !.vscode/tasks.json
+# !.vscode/launch.json
+# !.vscode/extensions.json
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+
+# Marked by dev.
+/alpha*
+/data*
+/temp*
+!/data/*.py
+/logs
+/outputs
+/cache
+/instance
+/migrations
+
+# Temp files
+/examples/markdown.bbcode
+/examples/example-*.bbcode
+/examples/example-*.png
+/examples/example-*.html
+/examples/example-*/**
+
+# Ignore docs (maintained by another branch)
+/docs
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### SublimeText template
+# Cache files for Sublime Text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# Workspace files are user-specific
+*.sublime-workspace
+
+# Project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using Sublime Text
+# *.sublime-project
+
+# SFTP configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+Package Control.merged-ca-bundle
+Package Control.user-ca-bundle
+oscrypto-ca-bundle.crt
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+
+# Julia manifest file names
+Manifest.toml
+JuliaManifest.toml