python-mscl 67.1.0.1__py3-none-any.whl

python_mscl/__init__.py

@@ -0,0 +1,13 @@
+from warnings import warn
+
+# from . import mscl
+
+warn(
+    "The 'python_mscl' package is archived, please use the official `pymscl` package instead.",
+    DeprecationWarning,
+    stacklevel=2
+)
+
+# 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"]

python_mscl-67.1.0.1.dist-info/METADATA

@@ -0,0 +1,85 @@
+Metadata-Version: 2.5
+Name: python-mscl
+Version: 67.1.0.1
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# python-mscl
+
+# ARCHIVED: There is now an official mscl library: [`pymscl`](https://pypi.org/project/pymscl). Please use that library instead.
+
+[![PyPI Downloads](https://static.pepy.tech/badge/python-mscl/week)](https://pepy.tech/projects/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, and directly provides the wheels!
+
+Only Python 3.x wheels are provided. If you need Python 2.x wheels, please open an issue.
+
+### Installation
+
+```bash
+pip install python-mscl
+```
+
+### Usage
+
+```python
+from python_mscl import mscl
+
+# ... use the MSCL library as you normally would
+```
+
+### 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 download_and_extract_assets.py` to fetch the latest tagged MSCL releases and extract them.
+4. Run `uv run run_build.py`, which will build the source distribution and wheel for your python
+version and architecture. The wheels will be placed in the `dist/` directory.
+
+Notes for me, the maintainer:
+
+5. Make sure that the constants in `constants.py` are updated, and that the MSCL repo still follows their
+versioning system. If not, update rest of the files accordingly.
+
+6. 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/*.whl`.
+
+7. 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.1.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+python_mscl/__init__.py,sha256=BwCpxcx20FSJujWUHNDVDZQFp3z8zf3mmkeov7-kar8,366
+python_mscl/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+python_mscl-67.1.0.1.dist-info/METADATA,sha256=vNbmCA4Ak_X2Rs_1T-7-mHBx2FafJG6PFhBiVMrP1wQ,3307
+python_mscl-67.1.0.1.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+python_mscl-67.1.0.1.dist-info/licenses/LICENSE,sha256=HoK_Ay_yWSgBIvLdRPRW9yt-1Es1-EX48iVfRrGz6sA,1064
+python_mscl-67.1.0.1.dist-info/RECORD,,

python_mscl-67.1.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

python_mscl-67.1.0.1.dist-info/licenses/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.