First Stable release of the python library

.github/workflows/CD.yml

@@ -1,120 +1,69 @@
-name: CD Pipeline
+name: CI
 
-# The pipeline is triggered by tags being pushed.
 on:
   push:
-    tags:        
-      - 'v*.*.*'   # Library version
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
+    branches:
+      - release
+  workflow_dispatch:
 
 jobs:
-  Continuous_Deployment:
+  build:
     runs-on: ubuntu-latest
-
-    # 1. Extract information from the tag (version number, channel).
-    # 2. Build the python package.
-    # 3. Update the package to the repo.
-    steps:
 
-    # Checkout the source and the submodules
-    - name: Checkout repository and submodules
-      uses: actions/checkout@v3
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
       with:
-        submodules: recursive
-        token: ${{ secrets.API_TOKEN_GITHUB }}
-        persist-credentials: true
+        submodules: true
+        fetch-depth: 0
 
-    ############## 1. Extract information from the tag ##############
+    - name: Update submodules
+      run: git submodule update --init --recursive
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
 
-    # Check tag
-    - name: Check tag
+    - name: Install build dependencies
       run: |
-        echo "Checking tag: ${GITHUB_REF_NAME}"
-        source ./scripts/github-tag
-        CheckTag ${GITHUB_REF_NAME}
-
-    # Get version number
-    - name: Tag -> Version
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Transpile Schema
       run: |
-        source scripts/github-tag
-        echo "PACKAGE_VERSION=$(VersionFromTag ${GITHUB_REF_NAME})" >> $GITHUB_ENV
+        python ./scripts/build_proto.py
 
-    # Get the release channel: stable vs testing
-    - name: Tag -> Channel
-      run: |
-        source scripts/github-tag
-        echo "PACKAGE_CHANNEL=$(ChannelFromTag ${GITHUB_REF_NAME})" >> $GITHUB_ENV
+    - name: Build the package
+      run: python -m build
 
-    # Print out info
-    - name: Package Info
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
       run: |
-        echo "Version: $PACKAGE_VERSION"
-        echo "Channel: $PACKAGE_CHANNEL"
-
-
-    ############## 2. Build the python package. ##############
+        pip install twine
+        twine upload --verbose --repository pypi dist/*
 
-    # Install dependencies
-    - name: Install dependencies
+    - name: Commit and push changes
       run: |
-          pip3 install -r requirements.txt
-          pip3 install twine
-
-    # Set version
-    - name: Set Version
-      run: echo "__version__ = \"${{ env.PACKAGE_VERSION }}\"" > maf_three/__init__.py
-
-    # Build proto files
-    - name: Build proto files
-      run: python3 ./scripts/build-proto.py 
-
-    # Build
-    - name: Build
-      run: python3 -m build
-
-    # Install our package (required for the tests to find the namespace : MF.V3)
-    - name: Install
-      run: pip3 install ./dist/maf_three-${{ env.PACKAGE_VERSION }}-py3-none-any.whl
-
-    # Run the tests
-    - name: Test
-      run: python3 -m pytest
-
-    # Build the documentation
-    - name: Documentation
-      run: python3 ./scripts/build-doc.py 
-
-
-    ############## 3. Upload the package and the documentation. ##############
-
-    # Upload python package to testpypi
-    - name: Upload to TestPyPi
-      run: twine upload --repository testpypi dist/* -u__token__ -p${{ secrets.TESTPYPI_TOKEN }}
-      #run: twine upload dist/* -u__token__ -p${{ secrets.PYPI_TOKEN }}
-
-
-    # Upload the documentation
-    - name: Setup Pages
-      uses: actions/configure-pages@v5
+        git config --global user.name 'github-actions[bot]'
+        git config --global user.email 'github-actions[bot]@matterandform.net'
+        git add .
+        git commit -m "Publish new version to PyPi [skip ci]"
+        git push
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Extract version
+      id: extract_version
+      run: |
+        CURRENT_VERSION=$(grep -oP "(?<=__version__ = ')[^']*" ./three/__init__.py)
+        echo "TAG=$CURRENT_VERSION" >> $GITHUB_ENV
 
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
+    - name: Create a Release
+      uses: softprops/action-gh-release@v1
       with:
-        path: './doc/build/html'
-
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4
-
-
+        files: dist/*
+        token: ${{ secrets.GITHUB_TOKEN }}
+        tag_name: ${{ env.TAG }}

.github/workflows/CI.yml

@@ -1,69 +1,76 @@
-name: CI Pipeline
+name: CI
 
-# Triggers of the Action: Push or Pull Request
 on:
-  pull_request:
-     branches: [ develop ]    
-     types: [opened, review_requested, ready_for_review, synchronize]
-
-  # Allows you to run this workflow manually from the Actions tab (when this yml is in the main branch)
+  push:
+    branches:
+      - develop
   workflow_dispatch:
 
 jobs:
   build:
-    if: ${{ github.event_name == 'push' || !github.event.pull_request.draft }}
-    strategy:
-      fail-fast: false # allow other OS to keep running when one fails
-      matrix: # Linux ; MacOS ; Windows
-        sys:
-          - { os: ubuntu-latest,  shell: bash}
-          #- { os: windows-latest, shell: 'msys2 {0}' }
-          #- { os: macos-latest,   shell: bash}
-
-    # Set the default shell
-    defaults:
-      run:
-        shell: ${{ matrix.sys.shell }}
-
-    runs-on: ${{ matrix.sys.os }}
-
-####################################################################
+    runs-on: ubuntu-latest
+
     steps:
-
-    # Checkout the source and the submodules
-    - name: Checkout repository and submodules
-      uses: actions/checkout@v3
+    - name: Checkout code
+      uses: actions/checkout@v2
       with:
-        submodules: recursive
-        token: ${{ secrets.API_TOKEN_GITHUB }}
-        persist-credentials: true
+        submodules: true
+        fetch-depth: 0
 
-    # Install dependencies
-    - name: Install dependencies
-      run: pip3 install -r requirements.txt
-
-    # Set version
-    - name: Set Version
-      run: echo "__version__ = \"0.0.0\"" > maf_three/__init__.py
+    - name: Update submodules
+      run: git submodule update --init --recursive
+
+    - name: Increment Version
+      run: |
+        ./scripts/incrementVersion.sh
 
-    # Build proto files
-    - name: Build proto files
-      run: python3 ./scripts/build-proto.py 
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.x'
 
-    # Build
-    - name: Build
-      run: python3 -m build
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Transpile Schema
+      run: |
+        python ./scripts/build_proto.py
 
-    # Install our package (required for the tests to find the namespace : MF.V3)
-    - name: Install
-      run: pip3 install ./dist/maf_three-0.0.0-py3-none-any.whl
+    - name: Build the package
+      run: python -m build
 
-    # Run the tests
-    - name: Test
-      run: python3 -m pytest
+    - name: Publish to TestPyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+      run: |
+        pip install twine
+        twine upload --verbose --repository testpypi dist/*
 
-    # Build the documentation
-    - name: Documentation
-      run: python3 ./scripts/build-doc.py 
+    - name: Commit and push changes
+      run: |
+        git config --global user.name 'github-actions[bot]'
+        git config --global user.email 'github-actions[bot]@matterandform.net'
+        git add .
+        git commit -m "CI: Version bump and transpiled code [skip ci]"
+        git push
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+    - name: Extract version number
+      id: extract_version
+      run: |
+        CURRENT_VERSION=$(grep -oP "(?<=__version__ = ')[^']*" ./three/__init__.py)
+        echo "VERSION=$CURRENT_VERSION" >> $GITHUB_ENV
 
+    - name: Create Pull Request to merge develop into release
+      uses: peter-evans/create-pull-request@v3
+      with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: "CI: Merge develop into release"
+          base: "develop"
+          branch: "release"
+          title: "New Release Candidate v${{ env.VERSION }}"
+          body: "This is an new release candidate for three-python. Merging this will distribute the new version to pypi."

.gitignore

@@ -160,9 +160,4 @@ cython_debug/
 #.idea/
 
 
-## Matter And Form ##
-
-# Don't include protobuf generated files.
-maf_three/MF
-
-
+## Matter And Form ##

.vscode/launch.json

@@ -0,0 +1,51 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Transpile",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/scripts/transpileProto.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Simple Scanner Example",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/three/examples/simpleScanner.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "justMyCode": true
+        }
+        {
+            "name": "Python: Task Example",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/three/examples/task.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Calibrate Turntable Example",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/three/examples/turntableCalibration.py",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "justMyCode": true
+        },
+        {
+            "name": "Python: Setup Wheel",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${workspaceFolder}/three/setup.py",
+            "args": ["sdist", "bdist_wheel"],
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "justMyCode": true
+        }
+    ]
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Matter and Form
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.