python-mscl 67.0.0__tar.gz

python_mscl-67.0.0/.github/workflows/build_wheels.yml

@@ -0,0 +1,53 @@
+name: Build wheels
+
+on:
+  pull_request:
+    branches:
+      - '**'  # Matches all branch names, for PRs
+  push:
+    branches:
+      - 'main'  # Run tests on main branch
+
+jobs:
+  build-wheels:
+    name: Build wheels
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        python-version: [3.9, 3.11, 3.13]
+        exclude:
+          - os: windows-latest
+            python-version: 3.9
+          - os: windows-latest
+            python-version: 3.13
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install the project
+        run: uv sync
+
+      - name: Build the wheel
+        run: uv build --wheel
+
+      - name: Initialize test environment
+        run: |
+          uv init --no-workspace test
+          cd test
+          uv add ../dist/*.whl
+
+      - name: Verify installation
+        run: uv run -- python -c "from python_mscl import mscl"

python_mscl-67.0.0/.gitignore

@@ -0,0 +1,24 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# Environment variables:
+.env
+
+# Exclude local .deb and .zip files from mscl:
+mscl_release_assets/*.zip
+mscl_release_assets/*.deb
+
+# VSCode:
+.vscode/
+
+# Exclude build downloaded mscl files:
+src/mscl/mscl.py
+src/mscl/_mscl.so

python_mscl-67.0.0/.python-version

@@ -0,0 +1 @@
+3.13

python_mscl-67.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Harshil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

python_mscl-67.0.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: python-mscl
+Version: 67.0.0
+Summary: Easy to install python wrapper for the MSCL library.
+Author-email: Harshil <37377066+harshil21@users.noreply.github.com>
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# python-mscl
+
+Unofficial Python package for the [Microstrain Communication Library](https://github.com/LORD-MicroStrain/MSCL/tree/master).
+
+This library just makes it so that we can install the MSCL library using pip. Wheels are not provided. This will fetch the necessary files for your architecture and python
+version, and then build the wheel for you.
+
+It is therefore recommended to use a cache for your CI or package manager, unless you're okay with the ~20MB download every time you run your CI.
+
+### Installation
+
+```bash
+pip install python-mscl
+```
+
+### Usage
+
+```python
+from python_mscl import mscl
+
+# ... use the MSCL library as you normally would
+```
+
+### Windows support:
+
+The latest mscl version (v67.0.0) only has a .zip for python 3.11. It has been confirmed that it does not work on other python versions (You would get an import error). However the build itself would still go through.
+
+
+### Versioning system:
+
+This repository follows the same versioning system as the MSCL library. This is reflected in the tags of this repository.
+
+The version reflected in PyPI is as follows:
+
+```
+<MSCL_VERSION>.<REPO_VERSION>
+```
+
+E.g, there could be a version: `67.0.0.3` which would mean that the MSCL version is `67.0.0` and this is the third release of the python-mscl package.
+
+## Local Development:
+
+The below steps assume you have [`uv`](https://docs.astral.sh/uv/) installed.
+
+1. Clone the repo and `cd` into it.
+2. Optional: Create a .env file and insert your GITHUB_TOKEN= to make requests to the GitHub API.
+3. Edit & run `uv run main.py` to fetch the latest tagged MSCL releases and extract them.
+4. Run `uv build`, which will build the source distribution and wheel for your python
+version and architecture.
+
+Notes for me, the maintainer:
+5. Optional: Run `uv publish` to publish the package to PyPI. To upload to TestPyPI, uncomment lines in `pyproject.toml`, and run `uv publish --index testpypi dist/*.tar.gz`.
+6. Optional: To check if the package worked correctly: `uv add --index https://test.pypi.org/simple/ --index-strategy unsafe-best-match python-mscl` in a new uv project directory.
+
+
+## Issues:
+
+If you encounter any issues, please open an issue on this repository. I would have to 
+manually update this repository to the latest MSCL release. If it has been more than 48 hours since the latest release and I didn't update this repository, please open an issue. 
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

python_mscl-67.0.0/README.md

@@ -0,0 +1,64 @@
+# python-mscl
+
+Unofficial Python package for the [Microstrain Communication Library](https://github.com/LORD-MicroStrain/MSCL/tree/master).
+
+This library just makes it so that we can install the MSCL library using pip. Wheels are not provided. This will fetch the necessary files for your architecture and python
+version, and then build the wheel for you.
+
+It is therefore recommended to use a cache for your CI or package manager, unless you're okay with the ~20MB download every time you run your CI.
+
+### Installation
+
+```bash
+pip install python-mscl
+```
+
+### Usage
+
+```python
+from python_mscl import mscl
+
+# ... use the MSCL library as you normally would
+```
+
+### Windows support:
+
+The latest mscl version (v67.0.0) only has a .zip for python 3.11. It has been confirmed that it does not work on other python versions (You would get an import error). However the build itself would still go through.
+
+
+### Versioning system:
+
+This repository follows the same versioning system as the MSCL library. This is reflected in the tags of this repository.
+
+The version reflected in PyPI is as follows:
+
+```
+<MSCL_VERSION>.<REPO_VERSION>
+```
+
+E.g, there could be a version: `67.0.0.3` which would mean that the MSCL version is `67.0.0` and this is the third release of the python-mscl package.
+
+## Local Development:
+
+The below steps assume you have [`uv`](https://docs.astral.sh/uv/) installed.
+
+1. Clone the repo and `cd` into it.
+2. Optional: Create a .env file and insert your GITHUB_TOKEN= to make requests to the GitHub API.
+3. Edit & run `uv run main.py` to fetch the latest tagged MSCL releases and extract them.
+4. Run `uv build`, which will build the source distribution and wheel for your python
+version and architecture.
+
+Notes for me, the maintainer:
+5. Optional: Run `uv publish` to publish the package to PyPI. To upload to TestPyPI, uncomment lines in `pyproject.toml`, and run `uv publish --index testpypi dist/*.tar.gz`.
+6. Optional: To check if the package worked correctly: `uv add --index https://test.pypi.org/simple/ --index-strategy unsafe-best-match python-mscl` in a new uv project directory.
+
+
+## Issues:
+
+If you encounter any issues, please open an issue on this repository. I would have to 
+manually update this repository to the latest MSCL release. If it has been more than 48 hours since the latest release and I didn't update this repository, please open an issue. 
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+

python_mscl-67.0.0/build_helpers/release_downloader.py

@@ -0,0 +1,72 @@
+"""Downloads the Github release assets for the mscl library."""
+
+import os
+from pathlib import Path
+
+import requests
+from github import Github
+from github.GitRelease import GitRelease
+from github.GitReleaseAsset import GitReleaseAsset
+
+
+class GithubDownloader:
+    """Manages downloading the Github release assets for the mscl library, along with the
+    extracted files from this repository."""
+
+    def __init__(self):
+        self.github = Github(os.getenv("GITHUB_TOKEN"))
+        self.mscl_repo = "LORD-MicroStrain/MSCL"
+        self.python_mscl_repo = "harshil21/python-mscl"
+        self.latest_release = None
+
+    def get_latest_release(self) -> GitRelease:
+        """Returns the latest stable release for the given repo."""
+        if self.latest_release:
+            return self.latest_release
+
+        releases = self.github.get_repo(self.mscl_repo).get_releases()
+        for release in releases:
+            if release.prerelease:
+                continue
+            if release.tag_name.startswith("v"):
+                self.latest_release = release
+                break
+        return self.latest_release
+
+    def download_release_assets(self, output_dir: str):
+        """Downloads the release assets for the given repo and tag."""
+        release = self.get_latest_release()
+        output_path = Path(output_dir)
+        output_path.mkdir(parents=True, exist_ok=True)
+
+        asset: GitReleaseAsset
+        for asset in release.get_assets():
+            # Don't download the "Documentation" or "Examples"
+            if "Documentation" in asset.name or "Examples" in asset.name:
+                continue
+            # Don't download anything non-python:
+            if "Python" not in asset.name:
+                continue
+            # Only python 3 and above:
+            if "3" not in asset.name:
+                continue
+
+            self.download_asset(output_path, asset)
+
+    def download_asset(self, output_path: Path, asset: GitReleaseAsset) -> None:
+        response = requests.get(asset.browser_download_url, timeout=15)
+        asset_path = output_path / asset.name
+        asset_path.write_bytes(response.content)
+
+    def download_assets_from_folder(self, tag: str, folder_name: str) -> None:
+        """Downloads all the files under the `folder_name` for the given tag, from the
+        root of the repository."""
+
+        repo = self.github.get_repo(self.python_mscl_repo)
+        contents = repo.get_contents(folder_name, ref=tag)
+
+        for content in contents:
+            if content.type == "file":
+                response = requests.get(content.download_url, timeout=15)
+                file_path = Path(content.name)
+                file_path.write_bytes(response.content)

python_mscl-67.0.0/build_helpers/release_extractor.py

@@ -0,0 +1,113 @@
+"""Extracts the .deb and .zip releases for the mscl library."""
+
+import os
+import subprocess
+from pathlib import Path
+
+MSCL_VERSION = "v67.0.0"
+"""The mscl version to extract."""
+
+class ReleaseExtractor:
+    """Will extract the .deb and .zip releases for the mscl library."""
+
+    def __init__(self):
+        self.asset_dir = Path("mscl_release_assets")
+
+    def extract_assets(self):
+        """Extracts the .deb and .zip releases into the same directory."""
+
+        for file in self.asset_dir.iterdir():
+            if file.suffix == ".deb":
+                self.extract_deb(file)
+            elif file.suffix == ".zip":
+                self.extract_zip(file)
+
+    def extract_deb(self, file: Path):
+        """Extracts the .deb release."""
+        cwd = Path().cwd()
+
+        # Create a directory to extract the .deb file. Syntax: mscl-<arch>-<python-ver>-<mscl-ver>
+        parts = file.stem.split("_")
+        arch, py_ver = parts[1], parts[2]
+        mscl_versioned_name = f"mscl-{arch}-{py_ver}-{MSCL_VERSION}"
+        mscl_versioned_dir = cwd / self.asset_dir / mscl_versioned_name
+
+        # If output directory exists, remove it:
+        if mscl_versioned_dir.exists():
+            os.system(f"rm -rf {mscl_versioned_dir}")
+
+        mscl_versioned_dir.mkdir(parents=True, exist_ok=True)
+        file_relative = file.absolute().relative_to(mscl_versioned_dir, walk_up=True)
+
+        # Extract the .deb file
+        subprocess.run(["ar", "x", str(file_relative)], cwd=mscl_versioned_dir, check=True)
+
+        # Extract the data.tar.gz file:
+        data_tar = "data.tar.gz"
+
+        subprocess.run(["tar", "-xzf", data_tar], cwd=mscl_versioned_dir, check=True)
+
+        found_mscl_py = list(mscl_versioned_dir.rglob("mscl.py"))
+        found_mscl_so = list(mscl_versioned_dir.rglob("_mscl.so"))
+
+        if not found_mscl_py or not found_mscl_so:
+            raise FileNotFoundError(f"Could not find mscl.py or _mscl.so in {mscl_versioned_dir}")
+
+        # Move the extracted files to the root of the mscl_versioned_dir:
+        mscl_py = found_mscl_py[0]
+        mscl_so = found_mscl_so[0]
+
+        mscl_py.rename(mscl_versioned_dir / mscl_py.name)
+        mscl_so.rename(mscl_versioned_dir / mscl_so.name)
+
+        # Delete the remaining files in mscl_versioned_dir:
+        for f in mscl_versioned_dir.iterdir():
+            if f.stem in (mscl_py.stem, mscl_so.stem):
+                continue
+            if f.is_dir():
+                os.system(f"rm -rf {f}")
+            else:
+                f.unlink()
+
+    def extract_zip(self, file: Path) -> None:
+        """Extracts the .zip release."""
+
+        cwd = Path().cwd()
+
+        # Create a directory to extract the .zip file. Syntax: mscl-<arch>-<python-ver>-<mscl-ver>
+        parts = file.stem.split("_")
+        arch, py_ver = parts[2], parts[3]
+        mscl_versioned_name = f"mscl-Windows-{arch}-{py_ver}-{MSCL_VERSION}"
+        mscl_versioned_dir = cwd / self.asset_dir / mscl_versioned_name
+
+        # If output directory exists, remove it:
+        if mscl_versioned_dir.exists():
+            os.system(f"rm -rf {mscl_versioned_dir}")
+
+        mscl_versioned_dir.mkdir(parents=True, exist_ok=True)
+        file_relative = file.absolute().relative_to(mscl_versioned_dir, walk_up=True)
+
+        # Extract the .zip file
+        subprocess.run(["unzip", str(file_relative)], cwd=mscl_versioned_dir, check=True)  # noqa: S603, S607
+
+        found_mscl_py = list(mscl_versioned_dir.rglob("mscl.py"))
+        found_mscl_pyd = list(mscl_versioned_dir.rglob("_mscl.pyd"))
+
+        if not found_mscl_py or not found_mscl_pyd:
+            raise FileNotFoundError(f"Could not find mscl.py or _mscl.pyd in {mscl_versioned_dir}")
+
+        # Move the extracted files to the root of the mscl_versioned_dir:
+        mscl_py = found_mscl_py[0]
+        mscl_pyd = found_mscl_pyd[0]
+
+        mscl_py.rename(mscl_versioned_dir / mscl_py.name)
+        mscl_pyd.rename(mscl_versioned_dir / mscl_pyd.name)
+
+        # Delete the remaining files in mscl_versioned_dir:
+        for f in mscl_versioned_dir.iterdir():
+            if f.stem in (mscl_py.stem, mscl_pyd.stem):
+                continue
+            if f.is_dir():
+                os.system(f"rm -rf {f}")
+            else:
+                f.unlink()

python_mscl-67.0.0/hatch_build.py

@@ -0,0 +1,116 @@
+"""Specifies a hatch build hook to create the wheel for mscl."""
+
+import platform
+import shutil
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path(__file__).parent))
+
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+from build_helpers.release_downloader import GithubDownloader
+
+MSCL_VERSION = "v67.0.0"
+"""The mscl version to build the wheels of."""
+
+
+class CustomBuildHook(BuildHookInterface):
+    """Build hook to build wheels from the extracted .deb/.zip files."""
+
+    def _python_tag(self) -> str:
+        """Generate the Python tag (e.g., py39 for Python 3.9)."""
+        major = sys.version_info.major
+        minor = sys.version_info.minor
+        return f"cp{major}{minor}"
+
+    def _platform_tag(self) -> str:
+        """Generate the platform tag (e.g., linux_x86_64)."""
+        return platform.system().lower() + "_" + platform.machine()
+
+    def initialize(self, version, build_data):
+        """
+        Called before building the wheel/sdist.
+        We can download & extract the .deb here, and place
+        mscl.py and _mscl.so into src/mscl_pip/.
+        """
+        if self.target_name != "wheel":
+            return
+
+        build_data["pure_python"] = False
+        self.app.display_info(f"Running on {version=} and {build_data=}")
+        self.app.display_info(self.target_name)
+
+        # --- STEP 1: Determine which python version and arch we are on: ---
+        # a) Python version:
+        # syntax: Python<MAJOR>.<MINOR>
+
+        py_version = f"Python{sys.version_info.major}.{sys.version_info.minor}"
+
+        # b) Architecture:
+        # possible values: amd64, arm64, armhf.
+
+        arch = platform.machine()
+        if arch == "x86_64":
+            mscl_arch = "amd64"
+        elif arch == "aarch64":
+            mscl_arch = "arm64"
+        elif arch == "armv7l":
+            mscl_arch = "armhf"
+        elif arch == "AMD64":  # Windows
+            mscl_arch = "x64"
+        elif arch == "x86":  # Windows
+            mscl_arch = "x86"
+        else:
+            raise RuntimeError(f"Unknown architecture: {arch}")
+
+        # --- STEP 2: Download the 2 mscl files (mscl.py and _mscl.so) from the git repo: ---
+        # Folder name: mscl-<mscl_arch>-<python-ver>-<mscl-ver>  -> Linux
+        # Folder name: mscl-Windows-<mscl_arch>-<python-ver>-<mscl-ver>  -> Windows
+
+        # a) Create the folder name:
+
+        if platform.system() == "Linux":
+            build_data["tag"] = f"{self._python_tag()}-{self._python_tag()}-{self._platform_tag()}"
+            folder_name = f"mscl-{mscl_arch}-{py_version}-{MSCL_VERSION}"
+
+        # Windows is best effort matching since there's only python 3.11 available for v67.0.0:
+        else:
+            if mscl_arch == "x64":
+                build_data["tag"] = "py3-none-win_amd64"
+            elif mscl_arch == "x86":
+                build_data["tag"] = "py3-none-win32"
+            folder_name = f"mscl-Windows-{mscl_arch}-Python3.11-{MSCL_VERSION}"
+
+        # b) Use PyGithub to download the files from the folder:
+        self.app.display_waiting(f"Downloading files for {folder_name}...")
+
+        gh = GithubDownloader()
+        gh.download_assets_from_folder(
+            tag=MSCL_VERSION,
+            folder_name=f"mscl_release_assets/{folder_name}",
+        )
+
+        self.app.display_success("Downloaded files successfully.")
+
+        # --- STEP 3: Copy the files ("_mscl.so" & "mscl.py") to the src/mscl/ directory: ---
+        # Move from root (i.e. cwd) to src/mscl
+        # Use shutil.move() to move the files.
+
+        self.remove_existing_files(Path("src/python_mscl/"), ["_mscl.so", "_mscl.pyd", "mscl.py"])
+        shutil.move("mscl.py", "src/python_mscl/")
+        if platform.system() == "Windows":
+            shutil.move("_mscl.pyd", "src/python_mscl/")
+            build_data["artifacts"] = ["_mscl.pyd", "mscl.py"]
+        else:
+            shutil.move("_mscl.so", "src/python_mscl/")
+            build_data["artifacts"] = ["_mscl.so", "mscl.py"]
+
+        self.app.display_success("Moved files to src/python_mscl/ successfully. Building wheel...")
+
+    def remove_existing_files(self, directory: Path, files: list[str]) -> None:
+        """Remove the existing files from the directory."""
+        for file in files:
+            file_path = directory / file
+            if file_path.exists():
+                file_path.unlink()

python_mscl-67.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[project]
+name = "python-mscl"
+version = "67.0.0"
+description = "Easy to install python wrapper for the MSCL library."
+readme = "README.md"
+authors = [
+    { name = "Harshil", email = "37377066+harshil21@users.noreply.github.com" }
+]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Intended Audience :: Developers",
+]
+dependencies = []
+
+[dependency-groups]
+dev = ["ruff", "hatchling"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/python_mscl"]
+
+[tool.hatch.build.hooks.custom]
+path = "hatch_build.py"
+
+[tool.hatch.build.targets.sdist]
+exclude = ["mscl_release_assets/", "uv.lock", "main.py", "src/python_mscl/_mscl.so", 
+"src/python_mscl/mscl.py"]
+
+[build-system]
+requires = ["hatchling", "requests", "pygithub"]
+build-backend = "hatchling.build"
+
+# [[tool.uv.index]]
+# name = "testpypi"
+# url = "https://test.pypi.org/simple/"
+# publish-url = "https://test.pypi.org/legacy/"
+
+
+# RUFF:
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+show-fixes = true
+exclude = ["mscl_release_assets/"]
+
+[tool.ruff.lint]
+ignore = ["ISC001", "S603", "S605", "S607", "PLR0912"]
+select = ["E", "F", "I", "PL", "UP", "RUF", "PTH", "C4", "B", "PIE", "SIM", "RET", "RSE",
+          "G", "ISC", "PT", "ASYNC", "TCH", "SLOT", "PERF", "PYI", "FLY", "AIR", "Q", "INP", 
+          "W", "YTT", "DTZ", "ARG", "T20", "FURB", "D100", "D101", "D300", "D418",
+          "D419", "S", "NPY"]

python_mscl-67.0.0/src/python_mscl/__init__.py

@@ -0,0 +1,5 @@
+from . import mscl
+
+# Intentionally make the user can do `from python_mscl import mscl` instead of `import mscl` which
+# can be done by doing a from .mscl import * here.
+__all__ = ["mscl"]