prepare release

Author: pilotak

.github/workflows/release.yaml

@@ -25,7 +25,20 @@ jobs:
 
           echo ::set-output name=version::${VERSION}
 
-      - name: Publish a Python distribution to PyPI
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Install dependencies
+        run: |
+          python -m pip install build --user
+
+      - name: Build
+        run: |
+          python -m build --sdist --wheel --outdir dist/
+
+      - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__

.github/workflows/validate.yaml

@@ -40,8 +40,3 @@ jobs:
 
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@v1
-
-      - name: Test
-        run: |
-          pip install pytest pytest-cov
-          pytest tests/ --doctest-modules --cov=MCP2221 --cov-report term-missing

.gitignore

@@ -1,4 +1,7 @@
 .pytest_cache
 __pycache__
 junit
-.coverage
+.coverage
+build/
+dist/
+*.egg-info

MCP2221/MCP2221.py

@@ -68,41 +68,33 @@ def _getConfig(self):
         buf = [0] * 65
         buf[1] = 0x61  # get SRAM settings
         rbuf = self._send(buf)
-        print(rbuf)
+        # print(rbuf)
 
         buf[0 + 1] = 0x60  # set SRAM settings
 
         # Clock Output Divider Value
         buf[2 + 1] |= (rbuf[5] & 0b11111)
-        print("Clock divider:", rbuf[5] & 0b111,
-              "duty:", (rbuf[5] >> 3) & 0b11)
 
         # DAC Voltage Reference
         buf[3 + 1] |= rbuf[6] >> 5
-        print("DAC ref:", (rbuf[6] >> 6) & 0b11, "VRM:", (rbuf[6] >> 5) & 0b1)
 
         # ADC Voltage Reference
         buf[5 + 1] |= (rbuf[7] >> 2) & 0b111
-        print("ADC ref:", (rbuf[7] >> 3) & 0b11, "VRM:", (rbuf[7] >> 2) & 0b1)
 
         # Interrupt detection
         # TODO
 
         # GP0 Settings
         buf[8 + 1] = rbuf[22]
-        print("GP0 type:", rbuf[22] & 0b111, "input:", (rbuf[22] >> 3) & 0b1)
 
         # GP1 Settings
         buf[9 + 1] = rbuf[23]
-        print("GP1 type:", rbuf[23] & 0b111, "input:", (rbuf[23] >> 3) & 0b1)
 
         # GP2 Settings
         buf[10 + 1] = rbuf[24]
-        print("GP2 type:", rbuf[24] & 0b111, "input:", (rbuf[24] >> 3) & 0b1)
 
         # GP3 Settings
         buf[11 + 1] = rbuf[25]
-        print("GP3 type:", rbuf[25] & 0b111, "input:", (rbuf[25] >> 3) & 0b1)
 
         return buf
 

MCP2221/__init__.py

@@ -0,0 +1,3 @@
+"""
+Python driver for MCP2221A
+"""

README.md

@@ -1,8 +1,48 @@
 # Python module for MCP2221
-[![Build](https://github.com/pilotak/python-mcp2221/actions/workflows/build.yaml/badge.svg)](https://github.com/pilotak/python-mcp2221/actions/workflows/build.yaml)
+[![Build](https://github.com/pilotak/python-mcp2221/actions/workflows/validate.yaml/badge.svg)](https://github.com/pilotak/python-mcp2221/actions/workflows/validate.yaml)
+
+## Examples
+
+Read GP0
+```python
+from MCP2221 import MCP2221
+
+mcp2221 = MCP2221.MCP2221()
+mcp2221.InitGP(0, MCP2221.TYPE.INPUT)
+print(mcp2221.ReadGP(0))
+```
+
+Write GP0
+```python
+from MCP2221 import MCP2221
+
+mcp2221 = MCP2221.MCP2221()
+mcp2221.InitGP(0, MCP2221.TYPE.OUTPUT)
+print(mcp2221.WriteGP(0, 1))
+```
+
+Read ADC on GP1
+```python
+from MCP2221 import MCP2221
+
+mcp2221 = MCP2221.MCP2221()
+mcp2221.InitGP(1, MCP2221.TYPE.ADC)
+mcp2221.SetADCVoltageReference(MCP2221.VRM.VDD)
+print(mcp2221.ReadADC(1))
+```
+
+Write DAC on GP2
+```python
+from MCP2221 import MCP2221
+
+mcp2221 = MCP2221.MCP2221()
+mcp2221.InitGP(2, MCP2221.TYPE.DAC)
+mcp2221.SetDACVoltageReference(MCP2221.VRM.REF_2_048V)
+mcp2221.WriteDAC(12)
+```
 
 ## Tests
 ```sh
 pip install pytest pytest-cov
-pytest tests/ --doctest-modules --cov=MCP2221 --cov-report term-missing
+pytest tests/ --doctest-modules --cov=MCP2221
 ```

setup.py

@@ -0,0 +1,27 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="mcp2221",
+    version="1.0.0",
+    author="Pavel Slama",
+    author_email="info@pavelslama.cz",
+    description="Python driver for MCP2221A",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    keywords=['MCP2221', 'MCP2221A', 'GPIO', 'ADC', 'DAC', 'I2C'],
+    url="https://github.com/pilotak/python-mcp2221",
+    project_urls={
+        "Bug Tracker": "https://github.com/pilotak/python-mcp2221/issues",
+    },
+    packages=setuptools.find_packages(),
+    install_requires=['hidapi'],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires='>=3.7',
+)