Fix module name

.github/dependabot.yml

@@ -0,0 +1,19 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    # Workflow files stored in the
+    # default location of `.github/workflows`
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "[gha] "
+      prefix: "[gha] "
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    commit-message:
+      # Prefix all commit messages with "[pip] "
+      prefix: "[pip] "

.github/workflows/.pre-commit.yml

@@ -0,0 +1,19 @@
+name: pre-commit
+
+on:
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ "3.10" ]
+
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - uses: pre-commit/[email protected]

.github/workflows/publish-pypi.yml

@@ -0,0 +1,35 @@
+name: Upload to pypi.org
+
+on:
+  # Triggers the workflow when a release is created
+  release:
+    types: [created]
+
+  workflow_dispatch:
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ "3.10" ]
+
+    steps:
+      - name: Checkout source repository
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install and update pip and the build dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .[dev]
+      - name: Build and Upload to PyPI
+        run: |
+          python3 -m build
+          python3 -m twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}

.github/workflows/publish-test-pypi.yml

@@ -0,0 +1,40 @@
+name: Upload to test.pypi.org
+
+on:
+  # Triggers the workflow on push to the master branch
+  push:
+    branches: [ "master" ]
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ "3.10" ]
+
+    steps:
+      - name: Checkout source repository
+        uses: actions/checkout@v4
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install and update pip and the build dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install .[dev]
+      - name: Build and upload to PyPI
+        continue-on-error: true
+        run: |
+          python3 -m build
+          python3 -m twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TWINE_TEST_TOKEN }}
+          TWINE_REPOSITORY: testpypi

.github/workflows/pylint.yml

@@ -0,0 +1,35 @@
+name: pylint
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Run Pylint
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11" ]
+
+    steps:
+    - name: Checkout source repository
+      uses: actions/checkout@v4
+    - name: Set up python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies for testing
+      run: |
+        python3 -m pip install --upgrade pip
+        python3 -m pip install .[test]
+    - name: Run Pylint
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        pylint --reports n ug_gpib

.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    -   id: check-executables-have-shebangs
+        # Check for invalid files
+    -   id: check-toml
+        # Check Python files
+    -   id: end-of-file-fixer
+    -   id: fix-encoding-pragma
+        args: [--remove]
+    -   id: mixed-line-ending
+        args: [--fix=lf]
+    -   id: check-executables-have-shebangs
+    -   id: requirements-txt-fixer
+    -   id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+-   repo: https://github.com/psf/black
+    rev: 24.4.2
+    hooks:
+    -   id: black
+-   repo: https://github.com/asottile/blacken-docs
+    rev: 1.16.0
+    hooks:
+    -   id: blacken-docs
+        args: [--line-length=120]
+-   repo: https://github.com/PyCQA/isort
+    rev: 5.13.2
+    hooks:
+    -   id: isort
+-   repo: local
+    hooks:
+    -   id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        require_serial: true
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: 'v1.10.0'
+    hooks:
+    -   id: mypy

98-ugsimple.rules

@@ -1,3 +1,2 @@
 # UGSimple USB GPIB Adapter
 SUBSYSTEM=="usb", ATTR{idVendor}=="04d8", ATTR{idProduct}=="000c", MODE:="0666"
-

LICENSE

@@ -672,4 +672,3 @@ may consider it more useful to permit linking proprietary applications with
 the library.  If this is what you want to do, use the GNU Lesser General
 Public License instead of this License.  But first, please read
 <http://www.gnu.org/philosophy/why-not-lgpl.html>.
-

README.md

@@ -1,57 +1,99 @@
-# ugsimple-usb-gpib
-Python3 libusb UGSimple GPIB Driver
+[![pylint](../../actions/workflows/pylint.yml/badge.svg)](../../actions/workflows/pylint.yml)
+[![PyPI](https://img.shields.io/pypi/v/ug-gpib)](https://pypi.org/project/ug-gpib/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ug-gpib)
+![PyPI - Status](https://img.shields.io/pypi/status/ug-gpib)
+[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](LICENSE)
+[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+# ug_gpib
+A Python3 pyUSB driver for the LQ Electronics Corp UGPlus USB to GPIB Controller.
 
-Tested using Linux, should work for Mac OSX, Windows and any OS with Python libusb support.
+Tested using Linux, should work for Mac OSX, Windows and any OS with Python [pyUSB](https://github.com/pyusb/pyusb)
+support.
 
+:warning: **The device must be IEEE 488.1 compliant. It must assert the EOI line to signal the end of a line. If this is
+not the case, the controller cannot be used. Older devices, typically only send CR, LF, or CR-LF.**
+
+The [UGPlus](http://lqelectronics.com/Products/USBUG/UGPlus/UGPlus.html) is a fairly cheap controller, that supports
+simple GPIB read and write operations only. It does not support advanced GPIB features like serial polling for example,
+and it does not have line drivers to support long cables and lots of devices on the bus.
+
+The UGPlus does have several firmware bugs, I have tried to mitigate them to the best of my knowledge. See
+[below](#firmware-bugs) for details.
+
+If you are looking for advanced features I suggest buying either a Prologix GPIB adapter or one of the NI USB adapters.
+I can recommend the following libraries for both
+[Prologix GPIB adapter](https://github.com/PatrickBaus/pyAsyncPrologixGpib) and
+[Linux GPIB](https://github.com/PatrickBaus/pyAsyncGpib).
+
+The library is fully type-hinted.
 
 ## Setup
 
-### Linux
+To install the library in a virtual environment (always use venvs with every project):
+
+```bash
+virtualenv env  # virtual environment, optional
+source env/bin/activate
+pip install ug-gpib
+```
 
-It is recommended to add the udev rule so root isn't required.
+### Linux
+To access the raw usb port in Linux, root privileges are required. It is possible to use udev to change ownership of the
+usb port on creation. This can be done via a rules file.
 
 ```bash
 sudo cp 98-ugsimple.rules /etc/udev/rules.d/.
 sudo udevadm control --reload-rules
 ```
 
-
 ## Usage
 
 Initialize UGSimpleGPIB
 
 ```python
-from ugsimple.GPIB import UGSimpleGPIB
-mygpib = UGSimpleGPIB()
+from ug_gpib import UGPlusGpib
 
+gpib_controller = UGPlusGpib()
 ```
 
-Writing "my command" a command to address 0x02
+Writing "*IDN?" a command to address 0x02. Do note the GPIB commands must be byte strings.
 ```python
-mygpib.write( 0x02, "my command" )
+gpib_controller.write(2, b"*IDN?\n")
 ```
 
-Reading from address 0x02
+Reading from address 0x02 and decoding the byte string to a unicode string.
 ```python
-data = mygpib.read( 0x02 )
-print ( data )
+data = gpib_controller.read(2)
+print(data.decode())
 ```
 
-Writting and reading the returned result using the ask() method
-```python
-device_id = mygpib.ask( 0x02, 'ID?' )
-print ( device_id )
-```
+See [examples/](examples/) for more working examples. Including an example that shows how to use the library from the
+command line.
+
+## Firmware Bugs
+There are several bugs in the firmware of the UGPlus most of those are off-by-one errors and consequently out-of-bounds
+reads. I documented them
+[here](https://github.com/PatrickBaus/pyUgGpib/blob/f1bb0d2244304b3e3f9776606918eaa270d0e9dc/ug_gpib/ug_gpib.py#L152).
+Some of these bugs are also evident when using the software supplied by the manufacturer.
+The most obvious ones are the following:
+
+* Out-of-bounds read when reading the firmware version. The controller sends one more byte than requested.
+* Out-of-bounds read when discovering GPIB devices. The controller sends one more byte than requested.
+* Out-of-bounds read when the GPIB device does not return any data. The controller sends one more byte than requested.
 
-See ugsimple/GPIB.py for further documentation.
+## Versioning
 
+I use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](../../tags).
 
-## Notes
+## Documentation
+I use the [Numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style for documentation.
 
-Currently not well tested.
-The USB command set for the UGSimple GPIB adapter should be complete but hasn't been tested with many devices yet.
+## Authors
 
+* **Jacob Alexander** - *Initial work for the UGSimple* [Jacob Alexander](https://github.com/haata)
+* **Patrick Baus** - *Complete rewrite for the UGPlus* - [PatrickBaus](https://github.com/PatrickBaus)
 
-Comments/Bug Reports/Patches welcome :D
+## License
 
 
+This project is licensed under the GPL v3 license - see the [LICENSE](LICENSE) file for details