fusaware-instruments 0.1.0__tar.gz

fusaware_instruments-0.1.0/.github/workflows/ci.yaml

@@ -0,0 +1,114 @@
+name: CI
+
+on: push
+
+jobs:
+  lint-n-format:
+    name: Linting and formatting
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "0.9.26"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Format
+        run: uv run ruff format --check
+
+      - name: Lint
+        run: uv run ruff check
+
+      - name: Prune cache
+        run: uv cache prune --ci
+
+  type-check:
+    name: Run type checkers
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "0.9.26"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Pyright
+        run: uv run pyright
+
+      # TODO run multiple type checkers
+      #
+      # - name: Pyrefly
+      #   run: uv run pyrefly check
+      # - name: ty
+      #   run: uv run ty check
+
+      - name: Prune cache
+        run: uv cache prune --ci
+
+  test:
+    name: Run tests
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "0.9.26"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Prune cache
+        run: uv cache prune --ci
+
+  build:
+    name: Build project
+    strategy:
+      matrix:
+        os: [windows-latest, ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "0.9.26"
+
+      - name: Install the project
+        run: uv sync --locked --all-extras --dev
+
+      - name: Build project
+        run: uv build
+
+      - name: Prune cache
+        run: uv cache prune --ci

fusaware_instruments-0.1.0/.github/workflows/release.yaml

@@ -0,0 +1,51 @@
+name: "Publish"
+
+on:
+  push:
+    tags:
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+        with:
+          enable-cache: true
+          version: "0.9.26"
+
+      - name: Build
+        run: uv build
+
+      # This would be nice to have but it's hard to run things in this library without VISA simulation
+      # - name: Smoke test (wheel)
+      #   run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+      #
+      # - name: Smoke test (source distribution)
+      #   run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+
+      - name: Publish
+        run: uv publish
+
+      - name: Prune cache
+        run: uv cache prune --ci
+
+      # TODO enabled notifications for when this workflow fails
+      #
+      # - name: Report Status
+      #   if: ${{ always() && github.ref_name == 'main' }}
+      #   uses: ravsamhq/notify-slack-action@v2
+      #   with:
+      #     status: ${{ job.status }}
+      #     notify_when: 'failure'
+      #   env:
+      #     SLACK_WEBHOOK_URL: ${{ secrets.ACTION_MONITORING_SLACK }}

fusaware_instruments-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+.pytest_cache/
+.venv/
+build/
+dist/
+*.egg-info/
+
+manuals/

fusaware_instruments-0.1.0/.idea/.gitignore

@@ -0,0 +1,10 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Ignored default folder with query files
+/queries/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

fusaware_instruments-0.1.0/.idea/fusaware-instruments.iml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
+    </content>
+    <orderEntry type="jdk" jdkName="Python 3.13" jdkType="Python SDK" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+  <component name="TestRunnerService">
+    <option name="PROJECT_TEST_RUNNER" value="py.test" />
+  </component>
+</module>

fusaware_instruments-0.1.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

fusaware_instruments-0.1.0/.idea/misc.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="Black">
+    <option name="sdkName" value="Python 3.13" />
+  </component>
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.13" project-jdk-type="Python SDK" />
+</project>

fusaware_instruments-0.1.0/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/fusaware-instruments.iml" filepath="$PROJECT_DIR$/.idea/fusaware-instruments.iml" />
+    </modules>
+  </component>
+</project>

fusaware_instruments-0.1.0/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

fusaware_instruments-0.1.0/LICENSE

@@ -0,0 +1 @@
+TBD

fusaware_instruments-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.4
+Name: fusaware-instruments
+Version: 0.1.0
+Summary: Tiny, pragmatic VISA instrument drivers on top of PyVISA.
+Author-email: Your Name <you@example.com>
+License: MIT
+License-File: LICENSE
+Keywords: PyVISA,SCPI,VISA,automation,instruments,rigol
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.12
+Requires-Dist: pydantic>=2.10.6
+Requires-Dist: pyvisa>=1.13
+Provides-Extra: backends
+Requires-Dist: pyvisa-py>=0.7; extra == 'backends'
+Description-Content-Type: text/markdown
+
+# visa-instrument-drivers
+
+Tiny, pragmatic VISA instrument drivers built on PyVISA.
+
+```python
+from visa_instrument_drivers import RigolDP800
+
+psu = RigolDP800("DP832A")
+psu.connect("TCPIP::192.168.0.107::INSTR")
+psu.write_source_voltage(13.5)          # CH1
+print(psu.read_source_voltage())        # 13.5 (setpoint)
+psu.disconnect()
+
+```
+
+Build and publish
+
+```shell
+python -m pip install --upgrade pip build twine 
+python -m build 
+python -m twine upload --repository pypi dist/*
+```

fusaware_instruments-0.1.0/README.md

@@ -0,0 +1,22 @@
+# visa-instrument-drivers
+
+Tiny, pragmatic VISA instrument drivers built on PyVISA.
+
+```python
+from visa_instrument_drivers import RigolDP800
+
+psu = RigolDP800("DP832A")
+psu.connect("TCPIP::192.168.0.107::INSTR")
+psu.write_source_voltage(13.5)          # CH1
+print(psu.read_source_voltage())        # 13.5 (setpoint)
+psu.disconnect()
+
+```
+
+Build and publish
+
+```shell
+python -m pip install --upgrade pip build twine 
+python -m build 
+python -m twine upload --repository pypi dist/*
+```