https://github.com/harshil21/python-mscl
Provide a `pypi` package for the `mscl` library
https://github.com/harshil21/python-mscl
microstrain-comm mscl python uv
Last synced: 3 months ago
JSON representation
Provide a `pypi` package for the `mscl` library
- Host: GitHub
- URL: https://github.com/harshil21/python-mscl
- Owner: harshil21
- License: mit
- Created: 2025-01-04T00:32:04.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T01:59:57.000Z (3 months ago)
- Last Synced: 2025-03-01T16:01:52.851Z (3 months ago)
- Topics: microstrain-comm, mscl, python, uv
- Language: Python
- Homepage:
- Size: 41.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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:
```
.
```
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.