nc-gcode-interpreter 0.1.2__tar.gz

nc_gcode_interpreter-0.1.2/.github/workflows/build-and-release.yml

@@ -0,0 +1,263 @@
+# This file is autogenerated by maturin v1.7.4
+# To update, run
+#
+#    maturin generate-ci github --platform all
+#
+# Edited to:
+# - build using binary bindings
+# - extract the binaries from the wheel
+# - upload both the wheel and the binary to the release
+# - disable some platforms
+
+name: Build and Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+env:
+  PROJECT_NAME: "nc-gcode-interpreter"
+
+jobs:
+  linux:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-latest
+            target: x86_64
+        #   - runner: ubuntu-latest
+        #     target: x86
+          - runner: ubuntu-latest
+            target: aarch64
+        #   - runner: ubuntu-latest
+        #     target: armv7
+        #   - runner: ubuntu-latest
+        #     target: s390x
+        #   - runner: ubuntu-latest
+        #     target: ppc64le
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter -b bin
+          sccache: 'true'
+          manylinux: auto
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-linux-${{ matrix.platform.target }}
+          path: dist
+
+#   musllinux:
+#     runs-on: ${{ matrix.platform.runner }}
+#     strategy:
+#       matrix:
+#         platform:
+#           - runner: ubuntu-latest
+#             target: x86_64
+#           - runner: ubuntu-latest
+#             target: x86
+#           - runner: ubuntu-latest
+#             target: aarch64
+#           - runner: ubuntu-latest
+#             target: armv7
+#     steps:
+#       - uses: actions/checkout@v4
+#       - uses: actions/setup-python@v5
+#         with:
+#           python-version: 3.12
+#       - name: Build wheels
+#         uses: PyO3/maturin-action@v1
+#         with:
+#           target: ${{ matrix.platform.target }}
+#           args: --release --out dist --find-interpreter -b bin
+#           sccache: 'true'
+#           manylinux: musllinux_1_2
+#       - name: Upload wheels
+#         uses: actions/upload-artifact@v4
+#         with:
+#           name: wheels-musllinux-${{ matrix.platform.target }}
+#           path: dist
+
+  windows:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: windows-latest
+            target: x64
+        #   - runner: windows-latest
+        #     target: x86
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+          architecture: ${{ matrix.platform.target }}
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter -b bin
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-windows-${{ matrix.platform.target }}
+          path: dist
+
+  macos:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: macos-12
+            target: x86_64
+          - runner: macos-14
+            target: aarch64
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist --find-interpreter -b bin
+          sccache: 'true'
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-macos-${{ matrix.platform.target }}
+          path: dist
+
+  emscripten:
+    runs-on: ${{ matrix.platform.runner }}
+    strategy:
+      matrix:
+        platform:
+          - runner: ubuntu-latest
+            target: wasm32-unknown-emscripten
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - run: pip install pyodide-build
+      - name: Get Emscripten and Python version info
+        shell: bash
+        run: |
+          echo EMSCRIPTEN_VERSION=$(pyodide config get emscripten_version) >> $GITHUB_ENV
+          echo PYTHON_VERSION=$(pyodide config get python_version | cut -d '.' -f 1-2) >> $GITHUB_ENV
+          pip uninstall -y pyodide-build
+      - uses: mymindstorm/setup-emsdk@v12
+        with:
+          version: ${{ env.EMSCRIPTEN_VERSION }}
+          actions-cache-folder: emsdk-cache
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+      - run: pip install pyodide-build
+      - name: Build wheels
+        uses: PyO3/maturin-action@v1
+        with:
+          target: ${{ matrix.platform.target }}
+          args: --release --out dist -i ${{ env.PYTHON_VERSION }} -b bin
+          sccache: 'true'
+          rust-toolchain: nightly
+      - name: Upload wheels
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-wasm
+          path: dist
+
+  sdist:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Build sdist
+        uses: PyO3/maturin-action@v1
+        with:
+          command: sdist
+          args: --out dist
+      - name: Upload sdist
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheels-sdist
+          path: dist
+
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    environment: release
+    if: ${{ startsWith(github.ref, 'refs/tags/') || github.event_name == 'workflow_dispatch' }}
+    # needs: [linux, musllinux, windows, macos, emscripten, sdist]
+    needs: [linux, windows, macos, emscripten, sdist]
+    permissions:
+      # Use to sign the release artifacts
+      id-token: write
+      # Used to upload release artifacts
+      contents: write
+      # Used to generate artifact attestation
+      attestations: write
+    steps:
+      - uses: actions/download-artifact@v4
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v1
+        with:
+          subject-path: 'wheels-*/*'
+      - name: Publish to PyPI
+        if: "startsWith(github.ref, 'refs/tags/')"
+        uses: PyO3/maturin-action@v1
+        with:
+          command: upload
+          args: --non-interactive --skip-existing wheels-*/*
+      - name: Extract binary and rename
+        env:
+          PROJECT_NAME: ${{ env.PROJECT_NAME }}
+        run: |
+          for wheel_dir in wheels-windows-* wheels-linux-* wheels-macos-*; do
+            arch=$(echo $wheel_dir | cut -d'-' -f3)
+            os=$(echo $wheel_dir | cut -d'-' -f2)
+            find ./$wheel_dir -name "*.whl" -exec sh -c '
+              wheel_name=$(basename "$1")
+              version=$(echo $wheel_name | sed -E "s/.*-([0-9]+\.[0-9]+\.[0-9]+)-.*/\1/")
+              unzip -d "$(dirname "$1")" "$1"
+              if [ "$2" = "windows" ]; then
+                binary_path=$(find "$(dirname "$1")" -name "*.exe")
+                if [ -n "$binary_path" ]; then
+                  mv "$binary_path" "$(dirname "$binary_path")/${PROJECT_NAME}_${version}_${2}_${3}.exe"
+                fi
+              else
+                binary_path=$(find "$(dirname "$1")" -type f -executable)
+                if [ -n "$binary_path" ]; then
+                  mv "$binary_path" "$(dirname "$binary_path")/${PROJECT_NAME}_${version}_${2}_${3}"
+                fi
+              fi
+            ' _ {} "$os" "$arch" \;
+          done
+      - name: Upload to GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: |
+            wheels-wasm/*.whl
+            wheels-sdist/*.tar.gz
+            wheels-windows-*/*.whl
+            wheels-windows-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_windows_*.exe
+            wheels-linux-*/*.whl
+            wheels-linux-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_linux_*
+            wheels-macos-*/*.whl
+            wheels-macos-*/*.data/scripts/${{ env.PROJECT_NAME }}_*_macos_*
+          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') }}

nc_gcode_interpreter-0.1.2/.gitignore

@@ -0,0 +1,28 @@
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+target/
+dist/
+
+# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+#Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+# RustRover
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# python
+.venv
+__pycache__
+python/**/*.so
+python/**/*.pyc

nc_gcode_interpreter-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing to NC-GCode-Interpreter
+
+We welcome contributions to the NC-GCode-Interpreter project! This document provides guidelines for contributing to the project.
+
+## Submitting Changes
+
+1. Open a pull request against the main repository.
+2. Describe your changes in the pull request description.
+
+## Code Style
+
+- Follow the Rust style guide for Rust code.
+- Use PEP 8 style guide for Python code.
+- Use meaningful variable and function names.
+- Comment your code where necessary.
+
+## Reporting Bugs
+
+- Use the GitHub Issues page to report bugs.
+- Describe the bug in detail, including steps to reproduce.
+- Include the version of NC-GCode-Interpreter you're using.
+- Include the platform you are using NC-GCode-Interpreter on. (e.g. Windows x64, macOS ARM)
+- Include whether the bug occurred in the Python package or the CLI.
+
+## Feature Requests
+We appreciate your interest in improving NC-GCode-Interpreter! Please note:
+
+- Our primary focus is on features that align with our specific business use case.
+- We encourage you to implement new features yourself if they fall outside our current scope.
+- If you believe a feature would benefit our business use case:
+  1. Open an issue on the GitHub Issues page to discuss the feature.
+  2. Clearly describe the feature and its potential benefits, especially how it relates to NC code interpretation and our use case.
+  3. Be prepared to (partially) implement the feature yourself if approved.
+
+## Questions
+
+If you have any questions about contributing, please open an issue or reach out to the maintainers.
+
+Thank you for contributing to NC-GCode-Interpreter!