bridgemate-dataconnector-client 1.0.0__tar.gz

bridgemate_dataconnector_client-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        include:
+          # One Windows job: the product's primary OS, and the only place the winreg
+          # port-discovery import path gets exercised.
+          - os: windows-latest
+            python: "3.12"
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install
+        run: pip install -e ".[dev]"
+
+      - name: Test
+        run: python -m pytest

bridgemate_dataconnector_client-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: Release
+
+# Publishes the package to PyPI and creates the git tag and GitHub release.
+#
+# PyPI authentication uses Trusted Publishing (OIDC) — no token secrets. One-time setup on
+# pypi.org: add a (pending) publisher for project bridgemate-dataconnector-client with
+# owner BridgeSystems, repository Bridgemate-Data-Connector-Scoring-Program-Client-Python,
+# workflow release.yml.
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (semver, without the v prefix), e.g. 1.0.0'
+        required: true
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Check the version matches pyproject.toml
+        run: |
+          grep -Fq "version = \"${{ inputs.version }}\"" pyproject.toml \
+            || { echo "pyproject.toml does not carry version ${{ inputs.version }}; bump it first."; exit 1; }
+
+      - name: Build sdist and wheel
+        run: |
+          pip install build
+          python -m build
+
+      - name: Test the built wheel
+        run: |
+          pip install pytest dist/*.whl
+          python -m pytest
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create tag and release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "v${{ inputs.version }}" \
+            --target "${{ github.sha }}" \
+            --title "v${{ inputs.version }}" \
+            --generate-notes

bridgemate_dataconnector_client-1.0.0/.gitignore

@@ -0,0 +1,7 @@
+/.venv/
+__pycache__/
+*.pyc
+/dist/
+*.egg-info/
+/.pytest_cache/
+/examples/.state.json

bridgemate_dataconnector_client-1.0.0/.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.debugpy"
+    ]
+}

bridgemate_dataconnector_client-1.0.0/.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: getting started (interactive)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/examples/getting_started.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "name": "Python: getting started (--scenario)",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/examples/getting_started.py",
+            "args": ["--scenario"],
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}"
+        },
+        {
+            "name": "Python: run tests (pytest)",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "pytest",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}"
+        }
+    ]
+}

bridgemate_dataconnector_client-1.0.0/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "python.defaultInterpreterPath": "${workspaceFolder}/.venv/Scripts/python.exe",
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": ["tests"]
+}

bridgemate_dataconnector_client-1.0.0/.vscode/tasks.json

@@ -0,0 +1,16 @@
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "pytest",
+            "type": "shell",
+            "command": "${workspaceFolder}/.venv/Scripts/python.exe",
+            "args": ["-m", "pytest"],
+            "group": {
+                "kind": "test",
+                "isDefault": true
+            },
+            "problemMatcher": []
+        }
+    ]
+}

bridgemate_dataconnector_client-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,12 @@
+# Contributing
+
+Thank you for your interest. This repository is maintained by Bridge Systems BV.
+
+- **Issues are welcome** — bug reports, documentation gaps, wire-format mismatches.
+- **Pull requests by prior agreement only** — please open an issue or a discussion first.
+- **Never edit `src/bridgemate_dataconnector/dto/` or `tests/fixtures/` by hand**: they are
+  generated from the
+  [.NET client repository](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client)
+  (its `tools/DtoGenerator`, run with `--python-out`), which is the single source of truth for the
+  wire format. Changes there flow here through regeneration; hand edits would be overwritten and
+  can silently break wire compatibility.

bridgemate_dataconnector_client-1.0.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

bridgemate_dataconnector_client-1.0.0/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: bridgemate-dataconnector-client
+Version: 1.0.0
+Summary: Scoring program client for the Bridgemate Data Connector over http. Communicate with Bridgemate Control Software (BCS 5) from a bridge scoring program written in Python.
+Project-URL: Homepage, https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python
+Project-URL: Documentation, https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/blob/master/Documentation/MD/index.md
+Project-URL: Issues, https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/issues
+Author: Bridge Systems BV
+License-Expression: LGPL-3.0-only
+License-File: LICENSE
+Keywords: bcs,bridge,bridgemate,data-connector,scoring
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Games/Entertainment
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Bridgemate Data Connector scoring program client for Python
+
+[![PyPI](https://img.shields.io/pypi/v/bridgemate-dataconnector-client)](https://pypi.org/project/bridgemate-dataconnector-client/)
+[![CI](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/actions/workflows/ci.yml/badge.svg)](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/actions/workflows/ci.yml)
+
+Python client for scoring programs to communicate with the **Bridgemate Data Connector** over http.
+Bridgemate Control Software (BCS 5) is needed to receive, process and return data from the Data
+Connector. This package is the Python counterpart of the
+[.NET client](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client);
+its wire format is generated from the .NET source and verified against golden fixtures, so the two
+clients speak an identical protocol.
+
+## Requirements
+
+- Python 3.10 or later — no dependencies outside the standard library
+- A reachable Bridgemate Data Connector (installed with BCS 5). When the scoring program runs on a
+  different computer than BCS, enable listening on the local network in BCS and allow the port
+  (default 5079) through the firewall on the BCS computer.
+
+## Installation
+
+```
+pip install bridgemate-dataconnector-client
+```
+
+## Quick start
+
+```python
+from bridgemate_dataconnector import DataConnectorClient
+from bridgemate_dataconnector.dto import DataConnectorResponseData, InitDTO
+
+# Data Connector on the same computer (port discovered through the registry, default 5079):
+client = DataConnectorClient("YourClubId", "YourLicenceKey")
+
+# Data Connector on another computer on the local network:
+client = DataConnectorClient("YourClubId", "YourLicenceKey", "http://192.168.1.50:5079")
+
+# Check the connection.
+response = client.connect()
+
+# Create an event in BCS (see the developer's guide for how to build the InitDTO).
+init_dto = InitDTO()
+# ... fill sessions, scoring groups, sections, tables, rounds ...
+response = client.initialize(init_dto)
+
+# Poll for new board results and accept them once processed.
+results = client.poll_for_results(session_guid)
+for result in results:
+    ...  # store the result in your scoring program
+if results:
+    client.accept_queue_data(session_guid, DataConnectorResponseData.Results)
+```
+
+All methods return a `ScoringProgramResponse` (poll methods return lists of DTOs) and never raise
+on communication problems: inspect `data_type`/`error_type` on the response, exactly like with the
+.NET client.
+
+### Naming
+
+Python code uses snake_case (`result.session_guid`), while the wire format and the developer's
+guide use PascalCase (`SessionGuid`). The mapping is one to one: drop the underscores and
+capitalize each word. The generated `to_dict`/`from_dict` methods of every DTO spell out the
+exact wire name of each field.
+
+### Polling model
+
+Http is stateless and the client keeps no connection open, so it fits both a long-running worker
+(poll in a loop) and a web application (poll on demand during a request). The id of the last
+polled queue item per data type is cached on the client instance and used by
+`accept_queue_data()`; in a web application poll and accept within the same request, or track the
+queue item ids yourself via `get_last_queue_item_id()`.
+
+## Getting started sample
+
+[examples/getting_started.py](examples/getting_started.py) is a small console application that
+exercises the whole workflow against a live Data Connector — use it as a template for your own
+scoring program:
+
+```
+python examples/getting_started.py               # interactive menu
+python examples/getting_started.py --scenario    # unattended full flow
+```
+
+Mind that **"Initialize event" starts Bridgemate Control Software** and creates a small test
+event (1 section, 2 tables, 3 rounds, 8 players). The poll queues only carry data once BCS
+produces it: enter a result in BCS (or on a Bridgemate) and then poll for results here. The
+sample prints every request and response envelope (wire trace, toggleable), which is the fastest
+way to learn the protocol.
+
+### Debugging in Visual Studio Code
+
+Open this folder in VS Code and install the recommended extensions (Python + Python Debugger,
+suggested automatically). Press <kbd>F5</kbd> — launch configurations for the sample and for
+pytest are provided in `.vscode/launch.json`. Set a breakpoint in
+`src/bridgemate_dataconnector/client.py::send_request()` to watch every envelope being built
+and sent.
+
+## Documentation
+
+The protocol, the procedures (initializing an event, updating movements, the queues) and all DTOs
+are described in the
+[Bridgemate Data Connector developer's guide](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/blob/master/Documentation/MD/index.md).
+The DTO classes in `src/bridgemate_dataconnector/dto` carry the same names as the guide (fields
+in snake_case, see Naming above).
+
+## Scope
+
+This first release covers the core workflow: `connect`/`ping`, `initialize`, `continue_event`,
+`update_movement`, `update_scoring_groups`, the `send_*` methods (results, player data,
+participations, handrecords, TD calls, Bridgemate 2/3 settings), the `poll_for_*` methods and
+`accept_queue_data`. BCS management commands are not wrapped yet; `send_request()` is public for
+anything the client does not cover.
+
+## Compatibility
+
+| Package version | Data Connector / BCS |
+| --- | --- |
+| 1.x | BCS 5.x (Data Connector with http support) |
+
+## Development
+
+The `src/bridgemate_dataconnector/dto` modules and `tests/fixtures` are **generated** from the
+.NET client repository (`tools/DtoGenerator` there) — do not edit them by hand. The fixture tests
+assert structural JSON equality with the exact bytes the .NET client produces.
+
+```
+python -m venv .venv
+.venv\Scripts\pip install -e ".[dev]"    # Windows; on Linux/macOS: .venv/bin/pip
+.venv\Scripts\python -m pytest
+```
+
+## Other platforms and support
+
+The same client exists for
+[.NET](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client) (the
+reference implementation, including the scoring program emulator),
+[PHP](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-PHP) and
+[Java](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Java).
+Questions are welcome in the
+[Discussions](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/discussions)
+of the main repository; see [SUPPORT.md](SUPPORT.md).
+
+## License
+
+LGPL-3.0-only, like the .NET client.

bridgemate_dataconnector_client-1.0.0/README.md

@@ -0,0 +1,145 @@
+# Bridgemate Data Connector scoring program client for Python
+
+[![PyPI](https://img.shields.io/pypi/v/bridgemate-dataconnector-client)](https://pypi.org/project/bridgemate-dataconnector-client/)
+[![CI](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/actions/workflows/ci.yml/badge.svg)](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/actions/workflows/ci.yml)
+
+Python client for scoring programs to communicate with the **Bridgemate Data Connector** over http.
+Bridgemate Control Software (BCS 5) is needed to receive, process and return data from the Data
+Connector. This package is the Python counterpart of the
+[.NET client](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client);
+its wire format is generated from the .NET source and verified against golden fixtures, so the two
+clients speak an identical protocol.
+
+## Requirements
+
+- Python 3.10 or later — no dependencies outside the standard library
+- A reachable Bridgemate Data Connector (installed with BCS 5). When the scoring program runs on a
+  different computer than BCS, enable listening on the local network in BCS and allow the port
+  (default 5079) through the firewall on the BCS computer.
+
+## Installation
+
+```
+pip install bridgemate-dataconnector-client
+```
+
+## Quick start
+
+```python
+from bridgemate_dataconnector import DataConnectorClient
+from bridgemate_dataconnector.dto import DataConnectorResponseData, InitDTO
+
+# Data Connector on the same computer (port discovered through the registry, default 5079):
+client = DataConnectorClient("YourClubId", "YourLicenceKey")
+
+# Data Connector on another computer on the local network:
+client = DataConnectorClient("YourClubId", "YourLicenceKey", "http://192.168.1.50:5079")
+
+# Check the connection.
+response = client.connect()
+
+# Create an event in BCS (see the developer's guide for how to build the InitDTO).
+init_dto = InitDTO()
+# ... fill sessions, scoring groups, sections, tables, rounds ...
+response = client.initialize(init_dto)
+
+# Poll for new board results and accept them once processed.
+results = client.poll_for_results(session_guid)
+for result in results:
+    ...  # store the result in your scoring program
+if results:
+    client.accept_queue_data(session_guid, DataConnectorResponseData.Results)
+```
+
+All methods return a `ScoringProgramResponse` (poll methods return lists of DTOs) and never raise
+on communication problems: inspect `data_type`/`error_type` on the response, exactly like with the
+.NET client.
+
+### Naming
+
+Python code uses snake_case (`result.session_guid`), while the wire format and the developer's
+guide use PascalCase (`SessionGuid`). The mapping is one to one: drop the underscores and
+capitalize each word. The generated `to_dict`/`from_dict` methods of every DTO spell out the
+exact wire name of each field.
+
+### Polling model
+
+Http is stateless and the client keeps no connection open, so it fits both a long-running worker
+(poll in a loop) and a web application (poll on demand during a request). The id of the last
+polled queue item per data type is cached on the client instance and used by
+`accept_queue_data()`; in a web application poll and accept within the same request, or track the
+queue item ids yourself via `get_last_queue_item_id()`.
+
+## Getting started sample
+
+[examples/getting_started.py](examples/getting_started.py) is a small console application that
+exercises the whole workflow against a live Data Connector — use it as a template for your own
+scoring program:
+
+```
+python examples/getting_started.py               # interactive menu
+python examples/getting_started.py --scenario    # unattended full flow
+```
+
+Mind that **"Initialize event" starts Bridgemate Control Software** and creates a small test
+event (1 section, 2 tables, 3 rounds, 8 players). The poll queues only carry data once BCS
+produces it: enter a result in BCS (or on a Bridgemate) and then poll for results here. The
+sample prints every request and response envelope (wire trace, toggleable), which is the fastest
+way to learn the protocol.
+
+### Debugging in Visual Studio Code
+
+Open this folder in VS Code and install the recommended extensions (Python + Python Debugger,
+suggested automatically). Press <kbd>F5</kbd> — launch configurations for the sample and for
+pytest are provided in `.vscode/launch.json`. Set a breakpoint in
+`src/bridgemate_dataconnector/client.py::send_request()` to watch every envelope being built
+and sent.
+
+## Documentation
+
+The protocol, the procedures (initializing an event, updating movements, the queues) and all DTOs
+are described in the
+[Bridgemate Data Connector developer's guide](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/blob/master/Documentation/MD/index.md).
+The DTO classes in `src/bridgemate_dataconnector/dto` carry the same names as the guide (fields
+in snake_case, see Naming above).
+
+## Scope
+
+This first release covers the core workflow: `connect`/`ping`, `initialize`, `continue_event`,
+`update_movement`, `update_scoring_groups`, the `send_*` methods (results, player data,
+participations, handrecords, TD calls, Bridgemate 2/3 settings), the `poll_for_*` methods and
+`accept_queue_data`. BCS management commands are not wrapped yet; `send_request()` is public for
+anything the client does not cover.
+
+## Compatibility
+
+| Package version | Data Connector / BCS |
+| --- | --- |
+| 1.x | BCS 5.x (Data Connector with http support) |
+
+## Development
+
+The `src/bridgemate_dataconnector/dto` modules and `tests/fixtures` are **generated** from the
+.NET client repository (`tools/DtoGenerator` there) — do not edit them by hand. The fixture tests
+assert structural JSON equality with the exact bytes the .NET client produces.
+
+```
+python -m venv .venv
+.venv\Scripts\pip install -e ".[dev]"    # Windows; on Linux/macOS: .venv/bin/pip
+.venv\Scripts\python -m pytest
+```
+
+## Other platforms and support
+
+The same client exists for
+[.NET](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client) (the
+reference implementation, including the scoring program emulator),
+[PHP](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-PHP) and
+[Java](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Java).
+Questions are welcome in the
+[Discussions](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/discussions)
+of the main repository; see [SUPPORT.md](SUPPORT.md).
+
+## License
+
+LGPL-3.0-only, like the .NET client.

bridgemate_dataconnector_client-1.0.0/SUPPORT.md

@@ -0,0 +1,12 @@
+# Support
+
+- **Questions** about writing a scoring program client, the protocol or any of the client
+  libraries: please use
+  [GitHub Discussions](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/discussions)
+  on the main (C#) client repository — one place for all languages, so answers help everyone.
+- **Bugs in this Python client**: open an
+  [issue here](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client-Python/issues).
+  Please include the request/response envelopes (run the getting-started sample with the wire
+  trace on) and the Data Connector version (`GET http://localhost:5079/` shows it).
+- **Documentation**: start with the
+  [developer's guide](https://github.com/BridgeSystems/Bridgemate-Data-Connector-Scoring-Program-Client/blob/master/Documentation/MD/index.md).