# horiba-python-sdk
<div align="center">
[](https://github.com/ThatsTheEnd/horiba-python-sdk/actions/workflows/build.yml)
[](https://pypi.org/project/horiba-sdk/)
[](https://pypi.org/project/horiba-sdk/)
[](https://github.com/ThatsTheEnd/horiba-python-sdk/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/astral-sh/ruff)
[](https://github.com/PyCQA/bandit)
[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.pre-commit-config.yaml)
[](https://github.com/ThatsTheEnd/horiba-python-sdk/releases)
[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)
[](https://horiba-python-sdk.readthedocs.io/en/latest/?badge=latest)
'horiba-sdk' is a package that provides source code for the development with Horiba devices
</div>
___
⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️⬇️
> [!WARNING]
> This SDK is under development and not yet released.
> [!IMPORTANT]
> For this python code to work, the SDK from Horiba has to be purchased, installed and licensed.
> The code in this repo and the SDK are under development and not yet released for public use!
⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️⬆️
___
**📦 Prerequisites**
* Python `>=3.9`
* ICL.exe installed as part of the Horiba SDK, licensed and activated
<details>
<summary>To make sure that the USB devices do not get disconnected, uncheck the following boxes in the properties</summary>
</details>
## 🛠️ Usage
<details>
<summary>Video of the steps below</summary>
</details>
0. (Optional but recommended) Work in a virtual environment:
Navigate to the (empty) project folder you want to work and run:
```bash
python -m venv .
```
Activate the virtual environment:
<details>
<summary>Windows</summary>
```powershell
.\Scripts\activate
```
</details>
<details>
<summary>Unix</summary>
```bash
source ./bin/activate
```
</details>
*Note: do deactivate it, simply run `deactivate`.*
1. Install the sdk:
```bash
pip install horiba-sdk
```
or install with `Poetry`
```bash
poetry add horiba-sdk
```
2. Create a file named `center_scan.py` and copy-paste the content of
[`examples/asynchronous_examples/center_scan.py`](examples/asynchronous_examples/center_scan.py)
3. Install the required library for plotting the graph in the example:
```bash
pip install matplotlib
```
or install with `Poetry`
```bash
poetry add matplotlib
```
4. Run the example with:
```bash
python center_scan.py
```
## 👩💻 First steps as contributor
### Clone and setup the repo
1. Clone the repo:
```bash
git clone https://github.com/ThatsTheEnd/horiba-python-sdk.git
cd horiba-python-sdk
```
2. If you don't have `Poetry` installed run:
```bash
make poetry-download
```
3. Initialize poetry and install `pre-commit` hooks:
```bash
make install
make pre-commit-install
```
4. Run the codestyle:
```bash
make codestyle
```
5. To push local changes to the remote repository, run:
```bash
git add .
git commit -m "feat: add new feature xyz"
git push
```
<!-- ### Set up bots -->
<!-- - Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies. -->
<!-- - Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing. -->
### Poetry
Want to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).
<details>
<summary>Details about Poetry</summary>
<p>
Poetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:
- `poetry add numpy@latest`
- `poetry run pytest`
- `poetry publish --build`
etc
</p>
</details>
### Building and releasing your package
Building a new version of the application contains steps:
- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.
- Update the `CHANGELOG.md` with `git-changelog -B auto -Tio CHANGELOG.md`
- Make a commit to `GitHub`.
- Create a tag and push it. The release is automatically triggered on tag push:
```bash
git tag vX.Y.Z # where the version MUST match the one you indicated before
git push --tags
```
### Makefile usage
[`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile) contains a lot of functions for faster development.
<details>
<summary>1. Download and remove Poetry</summary>
<p>
To download and install Poetry run:
```bash
make poetry-download
```
To uninstall
```bash
make poetry-remove
```
</p>
</details>
<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>
Install requirements:
```bash
make install
```
Pre-commit hooks coulb be installed after `git init` via
```bash
make pre-commit-install
```
</p>
</details>
<details>
<summary>3. Codestyle</summary>
<p>
Automatic formatting uses `pyupgrade`, `isort` and `black`.
```bash
make codestyle
# or use synonym
make formatting
```
Codestyle checks only, without rewriting files:
```bash
make check-codestyle
```
> Note: `check-codestyle` uses `isort`, `black` and `darglint` library
Update all dev libraries to the latest version using one comand
```bash
make update-dev-deps
```
<details>
<summary>4. Code security</summary>
<p>
```bash
make check-safety
```
This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.
```bash
make check-safety
```
</p>
</details>
</p>
</details>
<details>
<summary>5. Type checks</summary>
<p>
Run `mypy` static type checker
```bash
make mypy
```
</p>
</details>
<details>
<summary>6. Tests with coverage badges</summary>
<p>
Run `pytest`
Unix:
```bash
make test
```
Windows:
```powershell
poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
```
For the hardware tests run the following:
Windows:
```powershell
$env:HAS_HARDWARE="true"
# If you want a remote ICL be used for the tests
# $env:TEST_ICL_IP="192.168.21.24"
# $env:TEST_ICL_PORT="1234"
poetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/
```
Unix:
```bash
HAS_HARDWARE="true"
# If you want a remote ICL be used for the tests
# TEST_ICL_IP="192.168.21.24"
# TEST_ICL_PORT="1234"
make test
```
</p>
</details>
<details>
<summary>7. All linters</summary>
<p>
Of course there is a command to ~~rule~~ run all linters in one:
```bash
make lint
```
the same as:
```bash
make test
make check-codestyle
make mypy
make check-safety
```
</p>
</details>
<details>
<summary>8. Docker</summary>
<p>
```bash
make docker-build
```
which is equivalent to:
```bash
make docker-build VERSION=latest
```
Remove docker image with
```bash
make docker-remove
```
More information [about docker](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/docker).
</p>
</details>
<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files
```bash
make pycache-remove
```
Remove package build
```bash
make build-remove
```
Delete .DS_STORE files
```bash
make dsstore-remove
```
Remove .mypycache
```bash
make mypycache-remove
```
Or to remove all above run:
```bash
make cleanup
```
</p>
</details>
## 📚 Documentation
The latest documentation can be found at
[horiba-python-sdk.readthedocs.io](https://horiba-python-sdk.readthedocs.io/en/latest/).
In order to build it locally, run the following in the `docs/` folder:
```bash
make html
```
The documentation will then be built under `docs/build/html/`.
Documentation is built each time a commit is pushed on `main` or for pull
requests. When release tags are created in the repo, readthedocs will also tag
the documentation accordingly
## 🚀 Features
### Development features
- Supports for `Python 3.9` and higher.
- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/pyproject.toml).
- Automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff)
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
- Type checks with [`mypy`](https://mypy.readthedocs.io); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)
- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
- Ready-to-use [`.editorconfig`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.editorconfig), [`.dockerignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.dockerignore), and [`.gitignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.gitignore). You don't have to worry about those things.
### Deployment features
- `GitHub` integration: issue and pr templates.
- `Github Actions` with predefined [build workflow](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/workflows/build.yml) as the default CI/CD.
- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile#L89). More details in [makefile-usage](#makefile-usage).
- [Dockerfile](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/docker/Dockerfile) for your package.
- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.
### Open source community features
- Ready-to-use [Pull Requests templates](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/.github/ISSUE_TEMPLATE).
- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).
<!-- - [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/.stale.yml). -->
## 📈 Releases
You can see the list of available releases on the [GitHub Releases](https://github.com/ThatsTheEnd/horiba-python-sdk/releases) page.
We follow [Semantic Versions](https://semver.org/) specification.
<!-- We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels. -->
### List of labels and corresponding titles
| **Label** | **Title in Releases** |
| :-----------------------------------: | :---------------------: |
| `enhancement`, `feature` | 🚀 Features |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring |
| `build`, `ci`, `testing` | 📦 Build System & CI/CD |
| `breaking` | 💥 Breaking Changes |
| `documentation` | 📝 Documentation |
| `dependencies` | ⬆️ Dependencies updates |
<!-- You can update it in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). -->
<!-- GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them. -->
## 🛡 License
[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE) for more details.
## 📃 Citation
```bibtex
@misc{horiba-python-sdk,
author = {ZühlkeEngineering},
title = {'horiba-python-sdk' is a package that provides source code for the development with Horiba devices},
year = {2023},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/ThatsTheEnd/horiba-python-sdk}}
}
```
## Credits [](https://github.com/TezRomacH/python-package-template)
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)
Raw data
{
"_id": null,
"home_page": "https://github.com/ThatsTheEnd/horiba-python-sdk",
"name": "horiba-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "Horiba, SDK",
"author": "Z\u00fchlkeEngineering",
"author_email": "nikolaus.naredi-rainer@zuehlke.com",
"download_url": "https://files.pythonhosted.org/packages/a5/e8/dd7bb3593cd035a98c3386a20cebaa91f5e76e8d2fe1b5b158bce5b02e9c/horiba_sdk-0.4.0.tar.gz",
"platform": null,
"description": "# horiba-python-sdk\n\n<div align=\"center\">\n\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/actions/workflows/build.yml)\n[](https://pypi.org/project/horiba-sdk/)\n[](https://pypi.org/project/horiba-sdk/)\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)\n\n[](https://github.com/astral-sh/ruff)\n[](https://github.com/PyCQA/bandit)\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.pre-commit-config.yaml)\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/releases)\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)\n\n[](https://horiba-python-sdk.readthedocs.io/en/latest/?badge=latest)\n\n'horiba-sdk' is a package that provides source code for the development with Horiba devices\n\n</div>\n\n___\n\n\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\u2b07\ufe0f\n\n> [!WARNING] \n> This SDK is under development and not yet released.\n\n> [!IMPORTANT] \n> For this python code to work, the SDK from Horiba has to be purchased, installed and licensed.\n> The code in this repo and the SDK are under development and not yet released for public use!\n\n\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\u2b06\ufe0f\n\n___\n\n**\ud83d\udce6 Prerequisites**\n\n* Python `>=3.9`\n* ICL.exe installed as part of the Horiba SDK, licensed and activated\n\n <details>\n <summary>To make sure that the USB devices do not get disconnected, uncheck the following boxes in the properties</summary>\n\n \n\n </details>\n\n## \ud83d\udee0\ufe0f Usage\n\n<details>\n<summary>Video of the steps below</summary>\n\n\n\n</details>\n\n0. (Optional but recommended) Work in a virtual environment:\n\n Navigate to the (empty) project folder you want to work and run:\n\n ```bash\n python -m venv .\n ```\n\n Activate the virtual environment:\n\n <details>\n <summary>Windows</summary>\n\n ```powershell\n .\\Scripts\\activate\n ```\n </details>\n\n <details>\n <summary>Unix</summary>\n\n ```bash\n source ./bin/activate\n ```\n </details>\n\n *Note: do deactivate it, simply run `deactivate`.*\n\n\n1. Install the sdk:\n\n ```bash\n pip install horiba-sdk\n ```\n\n or install with `Poetry`\n\n ```bash\n poetry add horiba-sdk\n ```\n\n2. Create a file named `center_scan.py` and copy-paste the content of\n [`examples/asynchronous_examples/center_scan.py`](examples/asynchronous_examples/center_scan.py)\n\n3. Install the required library for plotting the graph in the example:\n\n ```bash\n pip install matplotlib\n ```\n\n or install with `Poetry`\n\n ```bash\n poetry add matplotlib\n ```\n\n4. Run the example with:\n\n ```bash\n python center_scan.py\n ```\n\n## \ud83d\udc69\u200d\ud83d\udcbb First steps as contributor\n\n### Clone and setup the repo\n\n1. Clone the repo:\n\n```bash\ngit clone https://github.com/ThatsTheEnd/horiba-python-sdk.git\ncd horiba-python-sdk\n```\n\n2. If you don't have `Poetry` installed run:\n\n```bash\nmake poetry-download\n```\n\n3. Initialize poetry and install `pre-commit` hooks:\n\n```bash\nmake install\nmake pre-commit-install\n```\n\n4. Run the codestyle:\n\n```bash\nmake codestyle\n```\n\n5. To push local changes to the remote repository, run:\n\n```bash\ngit add .\ngit commit -m \"feat: add new feature xyz\"\ngit push\n```\n\n<!-- ### Set up bots -->\n\n<!-- - Set up [Dependabot](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates) to ensure you have the latest dependencies. -->\n<!-- - Set up [Stale bot](https://github.com/apps/stale) for automatic issue closing. -->\n\n### Poetry\n\nWant to know more about Poetry? Check [its documentation](https://python-poetry.org/docs/).\n\n<details>\n<summary>Details about Poetry</summary>\n<p>\n\nPoetry's [commands](https://python-poetry.org/docs/cli/#commands) are very intuitive and easy to learn, like:\n\n- `poetry add numpy@latest`\n- `poetry run pytest`\n- `poetry publish --build`\n\netc\n</p>\n</details>\n\n### Building and releasing your package\n\nBuilding a new version of the application contains steps:\n\n- Bump the version of your package `poetry version <version>`. You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. For more details, refer to the [Semantic Versions](https://semver.org/) standard.\n- Update the `CHANGELOG.md` with `git-changelog -B auto -Tio CHANGELOG.md`\n- Make a commit to `GitHub`.\n- Create a tag and push it. The release is automatically triggered on tag push:\n\n ```bash\n git tag vX.Y.Z # where the version MUST match the one you indicated before\n git push --tags\n ```\n\n### Makefile usage\n\n[`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile) contains a lot of functions for faster development.\n\n<details>\n<summary>1. Download and remove Poetry</summary>\n<p>\n\nTo download and install Poetry run:\n\n```bash\nmake poetry-download\n```\n\nTo uninstall\n\n```bash\nmake poetry-remove\n```\n\n</p>\n</details>\n\n<details>\n<summary>2. Install all dependencies and pre-commit hooks</summary>\n<p>\n\nInstall requirements:\n\n```bash\nmake install\n```\n\nPre-commit hooks coulb be installed after `git init` via\n\n```bash\nmake pre-commit-install\n```\n\n</p>\n</details>\n\n<details>\n<summary>3. Codestyle</summary>\n<p>\n\nAutomatic formatting uses `pyupgrade`, `isort` and `black`.\n\n```bash\nmake codestyle\n\n# or use synonym\nmake formatting\n```\n\nCodestyle checks only, without rewriting files:\n\n```bash\nmake check-codestyle\n```\n\n> Note: `check-codestyle` uses `isort`, `black` and `darglint` library\n\nUpdate all dev libraries to the latest version using one comand\n\n```bash\nmake update-dev-deps\n```\n\n<details>\n<summary>4. Code security</summary>\n<p>\n\n```bash\nmake check-safety\n```\n\nThis command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.\n\n```bash\nmake check-safety\n```\n\n</p>\n</details>\n\n</p>\n</details>\n\n<details>\n<summary>5. Type checks</summary>\n<p>\n\nRun `mypy` static type checker\n\n```bash\nmake mypy\n```\n\n</p>\n</details>\n\n<details>\n<summary>6. Tests with coverage badges</summary>\n<p>\n\nRun `pytest`\n\nUnix:\n\n```bash\nmake test\n```\n\nWindows:\n\n```powershell\npoetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/\n```\n\nFor the hardware tests run the following:\n\nWindows:\n\n```powershell\n$env:HAS_HARDWARE=\"true\"\n# If you want a remote ICL be used for the tests\n# $env:TEST_ICL_IP=\"192.168.21.24\"\n# $env:TEST_ICL_PORT=\"1234\"\npoetry run pytest -c pyproject.toml --cov-report=html --cov=horiba_sdk tests/\n```\n\nUnix:\n\n```bash\nHAS_HARDWARE=\"true\"\n# If you want a remote ICL be used for the tests\n# TEST_ICL_IP=\"192.168.21.24\"\n# TEST_ICL_PORT=\"1234\"\nmake test\n```\n\n</p>\n</details>\n\n<details>\n<summary>7. All linters</summary>\n<p>\n\nOf course there is a command to ~~rule~~ run all linters in one:\n\n```bash\nmake lint\n```\n\nthe same as:\n\n```bash\nmake test\nmake check-codestyle\nmake mypy\nmake check-safety\n```\n\n</p>\n</details>\n\n<details>\n<summary>8. Docker</summary>\n<p>\n\n```bash\nmake docker-build\n```\n\nwhich is equivalent to:\n\n```bash\nmake docker-build VERSION=latest\n```\n\nRemove docker image with\n\n```bash\nmake docker-remove\n```\n\nMore information [about docker](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/docker).\n\n</p>\n</details>\n\n<details>\n<summary>9. Cleanup</summary>\n<p>\nDelete pycache files\n\n```bash\nmake pycache-remove\n```\n\nRemove package build\n\n```bash\nmake build-remove\n```\n\nDelete .DS_STORE files\n\n```bash\nmake dsstore-remove\n```\n\nRemove .mypycache\n\n```bash\nmake mypycache-remove\n```\n\nOr to remove all above run:\n\n```bash\nmake cleanup\n```\n\n</p>\n</details>\n\n## \ud83d\udcda Documentation\n\nThe latest documentation can be found at\n[horiba-python-sdk.readthedocs.io](https://horiba-python-sdk.readthedocs.io/en/latest/).\nIn order to build it locally, run the following in the `docs/` folder:\n\n```bash\nmake html\n```\n\nThe documentation will then be built under `docs/build/html/`.\n\nDocumentation is built each time a commit is pushed on `main` or for pull\nrequests. When release tags are created in the repo, readthedocs will also tag\nthe documentation accordingly\n\n## \ud83d\ude80 Features\n\n### Development features\n\n- Supports for `Python 3.9` and higher.\n- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/pyproject.toml).\n- Automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff)\n- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.\n- Type checks with [`mypy`](https://mypy.readthedocs.io); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)\n- Testing with [`pytest`](https://docs.pytest.org/en/latest/).\n- Ready-to-use [`.editorconfig`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.editorconfig), [`.dockerignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.dockerignore), and [`.gitignore`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.gitignore). You don't have to worry about those things.\n\n### Deployment features\n\n- `GitHub` integration: issue and pr templates.\n- `Github Actions` with predefined [build workflow](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/workflows/build.yml) as the default CI/CD.\n- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/Makefile#L89). More details in [makefile-usage](#makefile-usage).\n- [Dockerfile](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/docker/Dockerfile) for your package.\n- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).\n- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.\n\n### Open source community features\n\n- Ready-to-use [Pull Requests templates](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/ThatsTheEnd/horiba-python-sdk/tree/master/.github/ISSUE_TEMPLATE).\n- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.\n- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).\n<!-- - [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/.stale.yml). -->\n\n\n## \ud83d\udcc8 Releases\n\nYou can see the list of available releases on the [GitHub Releases](https://github.com/ThatsTheEnd/horiba-python-sdk/releases) page.\n\nWe follow [Semantic Versions](https://semver.org/) specification.\n\n<!-- We use [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you\u2019re ready. With the categories option, you can categorize pull requests in release notes using labels. -->\n\n### List of labels and corresponding titles\n\n| **Label** | **Title in Releases** |\n| :-----------------------------------: | :---------------------: |\n| `enhancement`, `feature` | \ud83d\ude80 Features |\n| `bug`, `refactoring`, `bugfix`, `fix` | \ud83d\udd27 Fixes & Refactoring |\n| `build`, `ci`, `testing` | \ud83d\udce6 Build System & CI/CD |\n| `breaking` | \ud83d\udca5 Breaking Changes |\n| `documentation` | \ud83d\udcdd Documentation |\n| `dependencies` | \u2b06\ufe0f Dependencies updates |\n\n<!-- You can update it in [`release-drafter.yml`](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/.github/release-drafter.yml). -->\n\n<!-- GitHub creates the `bug`, `enhancement`, and `documentation` labels for you. Dependabot creates the `dependencies` label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them. -->\n\n## \ud83d\udee1 License\n\n[](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE)\n\nThis project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/ThatsTheEnd/horiba-python-sdk/blob/master/LICENSE) for more details.\n\n## \ud83d\udcc3 Citation\n\n```bibtex\n@misc{horiba-python-sdk,\n author = {Z\u00fchlkeEngineering},\n title = {'horiba-python-sdk' is a package that provides source code for the development with Horiba devices},\n year = {2023},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/ThatsTheEnd/horiba-python-sdk}}\n}\n```\n\n## Credits [](https://github.com/TezRomacH/python-package-template)\n\nThis project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "'horiba-sdk' is a package that provides source code for the development with Horiba devices",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/ThatsTheEnd/horiba-python-sdk",
"Repository": "https://github.com/ThatsTheEnd/horiba-python-sdk"
},
"split_keywords": [
"horiba",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6959f8648a5b5da7fa37f5787d6c509f7aeb7206450f627d3c67eb1dfcb82b7a",
"md5": "b3a7cf5f443cbfd1af6155ea2b07dcee",
"sha256": "3540a2d0227cd2717426f35f79eba7a43e7d31b8701ed6d00848037473616608"
},
"downloads": -1,
"filename": "horiba_sdk-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b3a7cf5f443cbfd1af6155ea2b07dcee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 64193,
"upload_time": "2024-08-14T14:23:25",
"upload_time_iso_8601": "2024-08-14T14:23:25.074911Z",
"url": "https://files.pythonhosted.org/packages/69/59/f8648a5b5da7fa37f5787d6c509f7aeb7206450f627d3c67eb1dfcb82b7a/horiba_sdk-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a5e8dd7bb3593cd035a98c3386a20cebaa91f5e76e8d2fe1b5b158bce5b02e9c",
"md5": "f92fa0c1a13c545ab3fb3ff6a5a9c19f",
"sha256": "8fec812bc630a5156b234d4ba86605a180e6e1cc5b00f76f96cd973fc592cb62"
},
"downloads": -1,
"filename": "horiba_sdk-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "f92fa0c1a13c545ab3fb3ff6a5a9c19f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 51573,
"upload_time": "2024-08-14T14:23:26",
"upload_time_iso_8601": "2024-08-14T14:23:26.668327Z",
"url": "https://files.pythonhosted.org/packages/a5/e8/dd7bb3593cd035a98c3386a20cebaa91f5e76e8d2fe1b5b158bce5b02e9c/horiba_sdk-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 14:23:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ThatsTheEnd",
"github_project": "horiba-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "loguru",
"specs": [
[
"==",
"0.7.2"
]
]
},
{
"name": "websockets",
"specs": [
[
"==",
"12.0"
]
]
},
{
"name": "win32-setctime",
"specs": [
[
"==",
"1.1.0"
]
]
}
],
"lcname": "horiba-sdk"
}
JSON
