bss-mcp 0.1.0__tar.gz

bss_mcp-0.1.0/.env.example

@@ -0,0 +1,11 @@
+# Stage — BasicAuth
+BSS_URL=https://basicsupply.your-stage-env.example.com
+BSS_AUTH_TYPE=basic
+BSS_USER=your-username
+BSS_PASSWORD=your-password
+
+# Prod — OAuth (fill these instead of USER/PASSWORD)
+# BSS_AUTH_TYPE=oauth
+# BSS_CLIENT_ID=your-client-id
+# BSS_CLIENT_SECRET=your-client-secret
+# BSS_TOKEN_URL=https://your-auth-server/token

bss_mcp-0.1.0/.github/dependabot.yml

@@ -0,0 +1,18 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "@Hochfrequenz/python-developers-review-team"
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

bss_mcp-0.1.0/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [main]
+  schedule:
+    - cron: "29 14 * * 6"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v4
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v4
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v4

bss_mcp-0.1.0/.github/workflows/coverage.yml

@@ -0,0 +1,22 @@
+name: "Coverage"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Tests and Record Coverage
+        run: |
+          tox -e coverage

bss_mcp-0.1.0/.github/workflows/dependabot_automerge.yml

@@ -0,0 +1,18 @@
+name: Dependabot auto-approve / -merge
+on: pull_request
+
+jobs:
+  dependabot:
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    env:
+      PR_URL: ${{github.event.pull_request.html_url}}
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+    if: ${{ github.actor == 'dependabot[bot]' }}
+    steps:
+      - name: Approve a PR
+        run: gh pr review --approve "$PR_URL"
+      - name: Enable auto-merge for Dependabot PRs
+        run: gh pr merge --auto --squash "$PR_URL"

bss_mcp-0.1.0/.github/workflows/dev_test.yml

@@ -0,0 +1,28 @@
+name: "Test Dev Environment"
+# Checks that the dev environment (tox -e dev) can be set up.
+# This might not work, if different linting/testing envs refer to different versions of the same lib (e.g. typing-extensions).
+# Different versions of the same package might work for isolated specific envs (only linting, only testing...) but the dev environment inherits from all of them.
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest]
+    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
+          pip install tox
+      - name: Create a Dev Environment
+        run: |
+          tox -e dev

bss_mcp-0.1.0/.github/workflows/formatting.yml

@@ -0,0 +1,25 @@
+name: "Formatting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        tool: ["black", "isort"]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[formatting]
+      - name: ${{ matrix.tool }} Code Formatter
+        run: |
+          ${{ matrix.tool }} . --check

bss_mcp-0.1.0/.github/workflows/no_byte_order_mark.yml

@@ -0,0 +1,15 @@
+name: Prevent ByteOrderMarks
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  bom-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: arma-actions/bom-check@v1
+        name: Check for BOM

bss_mcp-0.1.0/.github/workflows/packaging_test.yml

@@ -0,0 +1,22 @@
+name: "Packaging Test"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  check_packaging:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run Packaging Test
+        run: |
+          tox -e test_packaging

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

@@ -0,0 +1,65 @@
+# This GitHub workflow is only needed for python package releases which are supposed to be published on pypi.
+# It requires the Github "environments" feature (see instructions below) it might not be available for private free accounts (but works for public or organization repos).
+# After creating the "release" environment in the Github repo settings, you need to enter your Github organization/user name + repo name + "python-publish.yml" workflow file name in the PyPI UI to make this work.
+
+# This workflow uploads a Python Package using Twine when a release is created.
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [created, edited]
+
+jobs:
+  tests:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.14"]
+        os: [ubuntu-latest]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run tox
+        run: |
+          tox
+
+  build-n-publish:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [ "3.14" ]
+        os: [ ubuntu-latest ]
+    # Specifying a GitHub environment, # Specifying a GitHub environment, which is strongly recommended by PyPI: https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+    # you have to create an environment in your repository settings and add the environment name here
+    environment: release
+    permissions:
+        # IMPORTANT: this permission is mandatory for trusted publishing
+        id-token: write
+    needs: tests
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[packaging]
+      - name: Build wheel and source distributions
+        run: |
+          python -m build
+      - name: Publish distribution 📦 to PyPI
+        if: startsWith(github.ref, 'refs/tags/v')
+        uses: pypa/gh-action-pypi-publish@release/v1

bss_mcp-0.1.0/.github/workflows/pythonlint.yml

@@ -0,0 +1,26 @@
+name: "Linting"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pylint:
+    name: Python Code Quality and Lint
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        linter-env: ["linting", "type_check", "spell_check"]
+    steps:
+      - uses: actions/checkout@v6
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: 3.14
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+      - name: Run ${{ matrix.linter-env }} via Tox
+        run: |
+          tox -e ${{ matrix.linter-env }}

bss_mcp-0.1.0/.github/workflows/unittests.yml

@@ -0,0 +1,26 @@
+name: "Unittests"
+
+on:
+  push:
+    branches: [main]
+  pull_request: {}
+jobs:
+  pytest:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+        os: [ubuntu-latest]
+    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
+          pip install tox
+      - name: Run the Unit Tests via Tox
+        run: |
+          tox -e tests

bss_mcp-0.1.0/.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+.idea/
+
+# vscode settings
+.vscode/
+
+# git worktrees
+.worktrees/
+
+src/_your_package_version.py

bss_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,44 @@
+Metadata-Version: 2.4
+Name: bss-mcp
+Version: 0.1.0
+Summary: MCP server for the Basic Supply Service (BSS) — read-only debug tools
+Author-email: Hochfrequenz Unternehmensberatung GmbH <info+pip@hochfrequenz.de>
+License: MIT
+Keywords: basicsupply,bss,mcp
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.11
+Requires-Dist: bssclient>=0.1
+Requires-Dist: fastmcp>=3.0
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic-settings>=2.7
+Requires-Dist: python-dotenv>=1.0
+Provides-Extra: coverage
+Requires-Dist: coverage>=7; extra == 'coverage'
+Provides-Extra: dev
+Requires-Dist: pip-tools; extra == 'dev'
+Provides-Extra: formatting
+Requires-Dist: black>=25; extra == 'formatting'
+Requires-Dist: isort>=5; extra == 'formatting'
+Provides-Extra: linting
+Requires-Dist: pylint>=4; extra == 'linting'
+Provides-Extra: packaging
+Requires-Dist: build>=1; extra == 'packaging'
+Requires-Dist: twine>=6; extra == 'packaging'
+Provides-Extra: spell-check
+Requires-Dist: codespell>=2; extra == 'spell-check'
+Provides-Extra: tests
+Requires-Dist: pytest-asyncio>=0.24; extra == 'tests'
+Requires-Dist: pytest-mock>=3; extra == 'tests'
+Requires-Dist: pytest>=9; extra == 'tests'
+Provides-Extra: type-check
+Requires-Dist: mypy>=1.10; extra == 'type-check'

bss_mcp-0.1.0/README.md

@@ -0,0 +1,271 @@
+# Python Template Repository including a `tox.ini`, Unittests&Coverage, Pylint & MyPy Linting Actions and a PyPI Publishing Workflow
+
+<!--- you need to replace the `organization/repo_name` in the status badge URLs --->
+
+![Unittests status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Unittests/badge.svg)
+![Coverage status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Coverage/badge.svg)
+![Linting status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Linting/badge.svg)
+![Black status badge](https://github.com/Hochfrequenz/python_template_repository/workflows/Formatting/badge.svg)
+
+This is a template repository.
+It doesn't contain any useful code but only a minimal working setup for a Python project including:
+
+- a basic **project structure** with
+  - tox.ini
+  - `pyproject.toml` where the project metadata and dependencies are defined
+  - and a requirements.txt derived from it
+  - an example class
+  - an example unit test (using pytest)
+- ready to use **Github Actions** for
+  - [pytest](https://pytest.org)
+  - [code coverage measurement](https://coverage.readthedocs.io) (fails below 80% by default)
+  - [pylint](https://pylint.org/) (only accepts 10/10 code rating by default)
+  - [mypy](https://github.com/python/mypy) (static type checks where possible)
+  - [black](https://github.com/psf/black) code formatter check
+  - [isort](https://pycqa.github.io/isort/) import order check
+  - [codespell](https://github.com/codespell-project/codespell) spell check (including an ignore list)
+  - autoresolve dev-dependencies with `tox -e compile_requirements`
+  - ready-to-use publishing workflow for pypi (see readme section below)
+
+By default, it uses Python version 3.13.
+
+This repository uses a [`src`-based layout](https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/).
+This approach has many advantages and basically means for developers, that all business logic lives in the `src` directory.
+
+## How to use this Repository on Your Machine
+
+### Installation of Tox / Creating the tox base venv
+If you ever set up your toxbase virtual environment already, skip this first step and continue with the project-specific setup.
+
+<details>
+<summary>
+ Creating the toxbase from scratch (windows)
+</summary>
+
+You can either follow the [installation instructions](https://tox.readthedocs.io/en/latest/installation.html)) and that a `.toxbase` environment has been created.
+Here we repeat the most important steps.
+
+#### Enure you are allowed to execute scripts in powershell (Windows only)
+On new Windows machines it is possible that the execution policy is set to restricted and you are not allowed execute scripts. You can find detailed information [here](https://learn.microsoft.com/de-de/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3).
+
+The quickest way to solve this problem: Open an Administrator Powershell (e.g. Windows PowerShell App, right click: 'Run as Adminstrator')
+```ps
+Set-ExecutionPolicy -ExecutionPolicy AllSigned
+```
+Then close the admin powershell and continue in the regular shell.
+
+#### Create the `.toxbase` environment
+`.toxbase` is a project independent virtual environment-template for all the tox environments on your machine. If anything is weird during the tox installation or after the installation, try turning your computer off and on again before getting too frustrated.
+Ask your Hochfrequenz colleagues for help.
+
+```ps
+# Change to your user directory, create tools directory if it does not exist
+$ cd C:\Users\YourUserName
+# Create a virtual environment called .toxbase
+$ python -m venv .toxbase
+```
+
+then
+```ps
+# Windows Powershell
+$ .\.toxbase\Scripts\Activate.ps1
+# XOR Windows default (e.g. cmder)
+λ .toxbase\Scripts\activate.bat
+# the virtual environment is active
+# if you see the environment name at the beginning of the line
+(.toxbase) $ python -m pip install --upgrade pip
+(.toxbase) $ pip install tox
+(.toxbase) $ tox --version
+```
+
+#### Add the toxbase interpreter to the Path environment variable
+Finally, we need to make the tox command available in all future terminal sessions.
+There are ways to achieve this goal using only the powershell commands, but we just use the "regular" way:
+
+* Type systemvariable in the search field of your windows taskbar.
+* Click on Edit system variables, then on environment variables.
+* In the next window select Path in the upper part (User variables for YourUserName) and click on edit.
+* Add a new path with `C:\Users\YourUserName\.toxbase\Scripts\`
+  * ⚠️ You have to replace YourUserName with your actual username in the path!
+     the path up to .toxbase has already been printed to the CLI in the tox --version command above
+
+* Save the settings.
+* Now you have to sign out and in again to make the changes work.
+
+You should now be able to type the following and get a reasonable answer
+```
+tox --version
+```
+in every shell, no matter if you activated the toxbase again.
+
+#### Umlaute in Paths
+Tox has an issue if you have an umlaut in your username. [This issue](https://github.com/tox-dev/tox/issues/1550#issuecomment-727824763) is well known.
+
+To solve it you have to add another environment variable `PYTHONIOENCODING` with the value `utf-8` ([source](https://github.com/tox-dev/tox/issues/1550#issuecomment-1011952057)).
+
+Start a new PowerShell session and try to run tox -e dev in your repository again.
+
+</details>
+
+<details>
+<summary>
+ Creating the toxbase from scratch (unix)
+</summary>
+Open a terminal and execute the following commands
+
+```sh
+# Change to your user directory
+$ cd ~
+# Create a virtual environment called .toxbase
+$ python -m venv .toxbase
+```
+Now we activate the virtual environment, update pip and install tox:
+
+```
+$ source .toxbase/bin/activate
+# the virtual environment is active
+# if you see the environment name at the beginning of the line
+(.toxbase) $ python -m pip install --upgrade pip
+(.toxbase) $ pip install tox
+(.toxbase) $ tox --version
+```
+Create a new folder bin in the home directory and add a symbolic link inside
+```
+cd
+# create a `bin` directory
+mkdir bin
+# set link to ~/bin/tox
+ln -s ~/.toxbase/bin/tox ~/bin/tox
+```
+Set the PATH variable
+
+```
+cd
+# open the config file .bashrc
+nano .bashrc
+# Go to the bottom of the file and insert
+# make tox accessible in each session from everywhere
+PATH = "${HOME}/bin:${PATH}"
+export PATH
+# save and close the file with CTRL+O and CTRL+X
+```
+#### fish
+```
+cd
+# open the config.fish file
+nano ~/.config/fish/config.fish
+# Go to the bottom of the file and insert
+# make tox accessible in each session from everywhere
+set PATH {$HOME}/bin $PATH
+# save and close the file with CTRL+O and CTRL+X
+```
+Check if everything works by opening a new terminal window and run
+```bash
+tox --version
+```
+
+</details>
+
+### Creating the project-specific dev environment.
+If tox is set up, you're ready to start:
+   1. clone the repository, you want to work in
+   2. create the `dev` environment on your machine. To do this:
+       a) Open a Powershell
+       b) change directory to your repository
+and finally type
+
+```bash
+tox -e dev
+```
+
+You have now created the development environment (dev environment). It is the environment which contains both the usual requirements as well as the testing and linting tools.
+
+### How to use with PyCharm
+
+1. You have cloned the repository, you want to work in, and have created the virtual environment, in which the repository should be executed (`your_repo/.tox/dev`). Now, to actually work inside the newly created environment, you need to tell PyCharm (your IDE) that it should use the virtual environment - to be more precise: the interpreter of this dev environment. How to do this:
+a) navigate to: File ➡ Settings (Strg + Alt + S) ➡ Project: your_project ➡ Python Interpreter ➡ Add interpreter ➡ Existing
+b) Choose as interpreter: `your_repo\.tox\dev\Scripts\python.exe` (under windows)
+2. Set the default test runner of your project to pytest. How to do it:
+a) navigate to Files ➡ Settings ➡ Tools ➡ Python integrated tools ➡ Testing: Default test runner
+b) Change to "pytest"
+If this doesn't work anymore, see [the PyCharm docs](https://www.jetbrains.com/help/pycharm/choosing-your-testing-framework.html)
+3. Set the `src` directory as sources root. How to do this:
+right click on 'src' ➡ "Mark directory as…" ➡ sources root
+If this doesn't work anymore, see: [PyCharm docs](https://www.jetbrains.com/help/pycharm/content-root.html).
+Setting the `src` directory right, allows PyCharm to effectively suggest import paths.
+If you ever see something like `from src.mypackage.mymodule import ...`, then you probably forgot this step.
+5. Set the working directory of the unit tests to the project root (instead of the unittest directory). How to do this:
+a) Open any test file whose name starts with `test_` in unit tests/tests
+b) Right click inside the code ➡ More Run/Debug ➡ Modify Run Configuration ➡ expand Environment collapsible ➡ Working directory
+c) Change to `your_repo` instead of `your_repo\unittests`
+By doing so, the import and other file paths in the tests are relative to the repo root.
+If this doesn't work anymore, see: [working directory of the unit tests](https://www.jetbrains.com/help/pycharm/creating-run-debug-configuration-for-tests.html)
+
+### How to use with VS Code
+All paths mentioned in this section are relative to the repository root.
+
+1. Open the folder with VS Code.
+2. **Select the python interpreter** ([official docs](https://code.visualstudio.com/docs/python/environments#_manually-specify-an-interpreter)) which is created by tox. Open the command pallett with `CTRL + P` and type `Python: Select Interpreter`. Select the interpreter which is placed in `.tox/dev/Scripts/python.exe` under Windows or `.tox/dev/bin/python` under Linux and macOS.
+3. **Set up pytest and pylint**. Therefore we open the file `.vscode/settings.json` which should be automatically generated during the interpreter setup. If it doesn't exist, create it. Insert the following lines into the settings:
+
+```json
+{
+  "python.testing.unittestEnabled": false,
+  "python.testing.nosetestsEnabled": false,
+  "python.testing.pytestEnabled": true,
+  "pythonTestExplorer.testFramework": "pytest",
+  "python.testing.pytestArgs": ["unittests"],
+  "python.linting.pylintEnabled": true
+}
+```
+
+4. Create a `.env` file and insert the following line
+
+For Windows:
+
+```
+PYTHONPATH=src;${PYTHONPATH}
+```
+
+For Linux and Mac:
+
+```
+PYTHONPATH=src:${PYTHONPATH}
+```
+
+This makes sure, that the imports are working for the unittests.
+At the moment I am not totally sure that it is the best practise, but it's getting the job done.
+
+5. Enjoy 🤗
+
+## Publishing on PyPI
+
+This repository contains all necessary CI steps to publish any project created from it on PyPI.
+It uses the trusted publishers workflow as described in the [official Python documentation](https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/).
+It just requires some manual adjustments/settings depending on your project:
+
+1. Fill out the metadata in the [`pyproject.toml`](pyproject.toml); Namely the package name and the dependencies which should be in sync with your `requirements.in`.
+2. Uncomment the lines in [`.github/workflows/python-publish.yml`](.github/workflows/python-publish.yml)
+3. Create a [new environment in your GitHub repository](https://github.com/Hochfrequenz/python_template_repository/settings/environments) and call it `release`.
+4. Set up a new trusted publisher [in your PYPI account](https://pypi.org/manage/account/publishing/).
+   1. PyPI Project Name: The name which you defined in the `pyproject.toml` is the name of the project which you have to enter here.
+   2. Owner: The GitHub organization name or GitHub username that owns the repository
+   3. Repository name: The name of the GitHub repository that contains the publishing workflow
+   4. Workflow name: The filename of the publishing workflow. This file should exist in the .github/workflows/ directory in the repository configured above. Here in our case: `python-publish.yml`
+   5. Environment name: The name of the GitHub Actions environment that the above workflow uses for publishing. Here in our case: `release`
+5. Now create a release by clicking on "Create new release" in the right Github sidebar (or visit `github.com/your-username/your-reponame/releases/new`). This should trigger the workflow (see the "Actions" tab of your repo).
+6. Check if the action failed. If it succeeded your PyPI account should now show the new project. It might take some minutes until the package can be installed via `pip install packagename` because the index has to be updated.
+7. Now create another PyPI token with limited scope and update the Github repository secret accordingly.
+
+## Contribute
+
+You are very welcome to contribute to this template repository by opening a pull request against the main branch.
+
+### GitHub Actions
+
+- Dependabot auto-approve / -merge:
+  - If the actor is the Dependabot bot (i.e. on every commit by Dependabot)
+    the pull request is automatically approved and auto merge gets activated
+    (using squash merge).
+    Note that if you haven't enabled "auto merge" for your repository, the auto merge activation will fail.
+    If you want to use a merge type other than "squash merge" you have to edit the workflow.

bss_mcp-0.1.0/domain-specific-terms.txt

@@ -0,0 +1 @@
+# contains 1 lower case word per line which are ignored in the spell_check

bss_mcp-0.1.0/pyproject.toml

@@ -0,0 +1,90 @@
+[build-system]
+requires = ["hatchling>=1.8.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bss-mcp"
+version = "0.1.0"
+description = "MCP server for the Basic Supply Service (BSS) — read-only debug tools"
+license = { text = "MIT" }
+requires-python = ">=3.11"
+authors = [{ name = "Hochfrequenz Unternehmensberatung GmbH", email = "info+pip@hochfrequenz.de" }]
+keywords = ["bss", "basicsupply", "mcp"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "bssclient>=0.1",
+    "fastmcp>=3.0",
+    "pydantic-settings>=2.7",
+    "httpx>=0.27",
+    "python-dotenv>=1.0",
+]
+
+[project.optional-dependencies]
+tests = [
+    "pytest>=9",
+    "pytest-asyncio>=0.24",
+    "pytest-mock>=3",
+]
+linting = [
+    "pylint>=4",
+]
+type_check = [
+    "mypy>=1.10",
+]
+spell_check = [
+    "codespell>=2",
+]
+coverage = [
+    "coverage>=7",
+]
+formatting = [
+    "black>=25",
+    "isort>=5",
+]
+packaging = [
+    "build>=1",
+    "twine>=6",
+]
+dev = [
+    "pip-tools",
+]
+
+[project.scripts]
+bss-mcp = "bss_mcp.server:main"
+
+[tool.hatch.build.targets.wheel]
+only-include = ["src"]
+sources = ["src"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["unittests"]
+
+[tool.black]
+line-length = 120
+target_version = ["py311", "py312", "py313", "py314"]
+
+[tool.isort]
+line_length = 120
+profile = "black"
+
+[tool.pylint."MESSAGES CONTROL"]
+max-line-length = 120
+
+[mypy]
+truethy-bool = true
+
+[tool.mypy]
+disable_error_code = []

bss_mcp-0.1.0/requirements.txt

@@ -0,0 +1,6 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile pyproject.toml
+#

bss_mcp-0.1.0/tox.ini

@@ -0,0 +1,93 @@
+[tox]
+envlist =
+    tests
+    linting
+    coverage
+    type_check
+skip_missing_interpreters = True
+skipsdist = True
+
+[testenv]
+commands = python -m pip install --upgrade pip
+
+[testenv:tests]
+# the tests environment is called by the Github action that runs the unit tests
+deps =
+    -r requirements.txt
+    .[tests]
+setenv = PYTHONPATH = {toxinidir}/src
+commands = python -m pytest --basetemp={envtmpdir} {posargs}
+
+[testenv:linting]
+# the linting environment is called by the Github Action that runs the linter
+deps =
+    {[testenv:tests]deps}
+    .[linting]
+    # add your fixtures like e.g. pytest_datafiles here
+setenv = PYTHONPATH = {toxinidir}/src
+commands =
+    pylint bss_mcp
+    pylint unittests --rcfile=unittests/.pylintrc
+    # add single files (ending with .py) or packages here
+
+[testenv:type_check]
+# the type_check environment checks the type hints using mypy
+setenv = PYTHONPATH = {toxinidir}/src
+deps =
+    {[testenv:tests]deps}
+    .[type_check]
+commands =
+    mypy --show-error-codes src/bss_mcp --strict
+    mypy --show-error-codes unittests --strict
+    # add single files (ending with .py) or packages here
+
+[testenv:spell_check]
+# the spellcheck environment checks the code for typos
+setenv = PYTHONPATH = {toxinidir}/src
+deps =
+    -r requirements.txt
+    .[spell_check]
+commands =
+    codespell --ignore-words=domain-specific-terms.txt src
+    codespell --ignore-words=domain-specific-terms.txt README.md
+    # add single files (ending with .py) or packages here
+
+[testenv:coverage]
+# the coverage environment is called by the Github Action that runs the coverage measurement
+changedir = unittests
+deps =
+    {[testenv:tests]deps}
+    .[coverage]
+setenv = PYTHONPATH = {toxinidir}/src
+commands =
+    coverage run -m pytest --basetemp={envtmpdir} {posargs}
+    coverage html --omit .tox/*,unittests/*
+    coverage report --fail-under 80 --omit .tox/*,unittests/*
+
+[testenv:compile_requirements]
+deps =
+    pip-compile-multi
+commands =
+    pip-compile-multi -d dev_requirements --autoresolve
+
+[testenv:dev]
+# the dev environment contains everything you need to start developing on your local machine.
+deps =
+    {[testenv:tests]deps}
+    {[testenv:linting]deps}
+    {[testenv:type_check]deps}
+    {[testenv:coverage]deps}
+    {[testenv:spell_check]deps}
+    .[formatting]
+    .[dev]
+commands =
+    python -m pip install --upgrade pip
+    pip install -r requirements.txt
+
+[testenv:test_packaging]
+skip_install = true
+deps =
+    .[packaging]
+commands =
+    python -m build
+    twine check dist/*

bss_mcp-0.1.0/unittests/.pylintrc

@@ -0,0 +1,11 @@
+[pylint]
+# for the unittests disable some pylint warnings, e.g. we don't want to force devs to write docstrings for every test
+disable =
+    C0114,  # disable missing-module-docstring
+    C0115,  # disable missing-class-docstring
+    C0116,  # disable missing-function-docstring
+    R0903,  # disable too-few-public-methods
+    W0621,  # disable redefined-outer-name (this is for the use of pytest fixtures)
+    R0801,  # disable duplicate-code (we prefer our test to be explicit rather than perfectly redundancy free)
+[pylint."MESSAGES CONTROL"]
+max-line-length = 120

bss_mcp-0.1.0/unittests/__init__.py

@@ -0,0 +1,4 @@
+"""
+This file is here, because this allows for best de-coupling of tests and application/library logic.
+Further reading: https://docs.pytest.org/en/6.2.x/goodpractices.html#tests-outside-application-code
+"""

bss_mcp-0.1.0/unittests/test_smoke.py

@@ -0,0 +1,5 @@
+import bss_mcp
+
+
+def test_bss_mcp_is_importable() -> None:
+    assert bss_mcp.__name__ == "bss_mcp"