Merge pull request #11 from linien-org/release/2.0.0

Release v2.0.0

Author: bleykauf

.flake8

@@ -0,0 +1,72 @@
+name: Upload Python Package
+
+on:
+  push:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+    - name: Install pypa/build
+      run: |
+        python -m pip install --upgrade pip
+        pip install build --user
+    - name: Build binary wheel and a source tarball
+      run: python -m build --sdist
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'release'
+    needs:
+    - build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/pyrp3
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v3
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' && !github.event.release.prerelease
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pyrp3
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v3
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/publish-pypi.yml

@@ -0,0 +1,76 @@
+# pyrp3
+
+Python 3 port (using [`2to3`](https://docs.python.org/3/library/2to3.html)) of
+[PyRedPitaya](https://github.com/clade/PyRedPitaya>) library in the `pyrp3` namespace.
+
+Note: The following is a copy of the Readme from the original repo and might not work 
+with this version of the library.
+
+## Overview
+
+This package provides a library to access the [Red Pitaya](http://redpitaya.com/) registers.
+This library consist of a C library (`libmonitor.c`) and a `ctypes` interface on the Python side. 
+
+An object-oriented interface to the different application (scope, generator, PID, AMS, ...) is 
+provided. This interface is implemented using Python properties (see usage below) and can quickly be
+extended to your own application. 
+
+A `rpyc` server is used in order to communicate with your computer. The interface is the same on the
+computer as the one on the board.
+
+## Installation
+
+To install `pyrp3`` on any machine, run the command:
+
+```bash
+  pip3 install pyrp3
+```
+
+## Usage
+
+You need to have Python installed on you Red Pitaya. 
+
+### Interactive Python
+
+Logging onto the redpitaya using ssh, one can start the ipython shell and run :
+
+```python
+
+    from pyrp3.board import RedPitaya
+
+    redpitaya = RedPitaya()
+
+    print(redpitaya.ams.temp) # Read property
+    redpitaya.hk.led = 0b10101010 # Write property
+```
+
+### Remote access
+
+You need to install the `pyrp3` package on your PC as well as `rpyc`: 
+
+```bash
+    rpyc_server
+```
+
+On the computer (replace `REDPITAYA_IP` by the string containing the IP address) : 
+
+```python
+    from rpyc import connect
+    from pyrp3.pc import RedPitaya
+
+    conn = connect(REDPITAYA_IP, port=18861)
+    redpitaya = RedPitaya(conn)
+
+    print(redpitaya.read(0x40000000)) # Direct access
+
+    print(redpitaya.ams.temp) # Read property
+    redpitaya.hk.led = 0b10101010 # Write property
+
+    from time import sleep
+    from pylab import *
+
+    redpitaya.scope.setup(frequency = 100, trigger_source=1)
+    sleep(100E-3)
+    plot(redpitaya.scope.times, redpitaya.scope.data_ch1)
+    show()
+```

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

@@ -1,2 +1,62 @@
+[build-system]
+requires = ["setuptools >= 30.3.0", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pyrp3"
+description = "Python utilities for RedPitaya"
+dynamic = ["version"]
+authors = [
+    { name = "Pierre Cladé", email = "[email protected]" },
+    { name = "Benjamin Wiegand", email = "[email protected]" },
+    { name = "Bastian Leykauf", email = "[email protected]" },
+    { name = "Doron Behar", email = "[email protected]" },
+]
+maintainers = [
+    { name = "Bastian Leykauf", email = "[email protected]" },
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "cached_property>=1.5.2",
+    "myhdl>=0.11",
+    "numpy>=1.21.5",
+    "rpyc>=5.0,<6.0",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: POSIX :: Linux",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Education",
+    "Topic :: Scientific/Engineering",
+]
+keywords = ["RedPitaya", "FPGA", "zynq"]
+
+[project.optional-dependencies]
+dev = [
+    "black>=22.8.0",
+    "pre-commit>=2.20.0",
+    "flake8>=5.0.4",
+    "isort>=5.10.1",
+    "flake8-pyproject>=1.2.3",
+    "setuptools_scm>=6.2",
+]
+
+[tool.setuptools]
+packages = ["pyrp3"]
+
+[tool.setuptools_scm]
+
+[project.urls]
+homepage = "https://github.com/linien-org/pyrp3/"
+repository = "https://github.com/linien-org/pyrp3/"
+
+[tool.flake8]
+max-line-length = 88
+extend-ignore = "E203"
+docstring-convention = "numpy"
+
 [tool.isort]
-profile = "black"
+profile = "black"

.github/workflows/publish.yml

@@ -1 +1,7 @@
-from ._version import __version__  # noqa F401
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("package-name")
+except PackageNotFoundError:
+    # package is not installed
+    pass