meshright 0.1.0__tar.gz

meshright-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Something went wrong
+about: MeshRight did something unexpected, or could not fix a model
+labels: bug
+---
+
+**What happened**
+<!-- What did you do, and what did MeshRight do? -->
+
+**What you expected**
+
+**The report**
+<!-- Paste the output of `meshright check yourfile.stl`, or a screenshot of the Problems list. -->
+
+**The model**
+<!-- If you can share it, attach the file (zip it if needed). Only share models you have the right to share, and nothing with personal data. Otherwise say where it came from: which scanner, app or website. -->
+
+**Your computer**
+- Windows / macOS / Linux:
+- MeshRight version (shown by `meshright --version`):

meshright-0.1.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,13 @@
+---
+name: Idea or request
+about: Something MeshRight should do, or do more simply
+labels: idea
+---
+
+**What are you trying to do?**
+<!-- The job, not the button: for example "print a bust I scanned at the museum". -->
+
+**What gets in the way today?**
+
+**How would you like it to work?**
+<!-- Keep it beginner friendly: what would someone who has never used a mesh tool click? -->

meshright-0.1.0/.github/workflows/pypi.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+# When a release is published on GitHub, build MeshRight and upload it to
+# PyPI, so anyone can install it with `pip install meshright`.
+# Uses PyPI "trusted publishing": no password or token is stored anywhere.
+# One-time setup on pypi.org: add a (pending) trusted publisher with owner
+# Huzy85, repository MeshRight, workflow pypi.yml and environment pypi.
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: python-package
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: python-package
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

meshright-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,76 @@
+name: Build apps
+
+# Builds the one-file MeshRight app for Windows, macOS and Linux.
+# Run it by hand from the Actions tab, or push a tag like v0.2.0 to also
+# publish a GitHub release with the three files attached.
+
+on:
+  workflow_dispatch:
+  push:
+    tags: ["v*"]
+    # Branch pushes build only when the packaging itself changes.
+    # (GitHub ignores path filters for tag pushes, so tags always build.)
+    branches: ["**"]
+    paths: ["packaging/**", ".github/workflows/release.yml"]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            file: MeshRight.exe
+            asset: MeshRight-windows.exe
+          - os: macos-latest
+            file: MeshRight
+            asset: MeshRight-macos
+          - os: ubuntu-22.04
+            file: MeshRight
+            asset: MeshRight-linux
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: pip install ".[dev]" pyinstaller
+      - name: Test
+        run: pytest -q
+      - name: Build
+        shell: bash
+        run: packaging/build.sh
+      - name: Smoke test the app
+        shell: bash
+        run: |
+          ./dist/${{ matrix.file }} serve --no-browser --port 8765 &
+          for i in $(seq 1 30); do
+            curl -sf http://127.0.0.1:8765/api/health && break
+            sleep 2
+          done
+          curl -sf http://127.0.0.1:8765/api/health
+      - name: Name the file
+        shell: bash
+        run: mv "dist/${{ matrix.file }}" "dist/${{ matrix.asset }}"
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ matrix.asset }}
+          path: dist/${{ matrix.asset }}
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+      - uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true

meshright-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,22 @@
+name: Tests
+
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest -q

meshright-0.1.0/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+venv/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Secrets and local settings: never commit these
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+secrets/
+credentials*.json
+
+# Editors and OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Personal test models: keep real scans out of the repo
+/scans/
+/models/
+*.local.stl
+*.local.obj
+*.local.ply
+
+# Packaged app builds
+*.spec

meshright-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,14 @@
+# Code of conduct
+
+MeshRight is for everyone, from first-time printers to experts. Be kind, be
+patient with beginners, and assume good intent.
+
+- Explain things plainly; nobody is expected to know the jargon.
+- Critique ideas and code, never people.
+- No harassment, insults or discrimination of any kind.
+- Do not share other people's personal data, or models you do not have the
+  right to share.
+
+We follow the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+Maintainers may remove comments or contributions that break these rules.
+Report problems privately to the maintainers through GitHub.

meshright-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to MeshRight
+
+Thanks for helping. MeshRight is meant to be a community project, so all kinds
+of help count: bug reports, example meshes that break things, documentation,
+design ideas and code.
+
+## Reporting a problem
+
+Open an issue and include:
+
+- what you did and what you expected to happen
+- the output of `meshright check yourfile.stl`
+- the file, if you can share it, or a description of where it came from
+  (which scanner, which app exported it)
+
+Please only attach models you have the right to share, and never attach
+anything containing personal data.
+
+## Setting up for development
+
+```bash
+git clone https://github.com/Huzy85/MeshRight.git
+cd MeshRight
+python -m venv .venv
+source .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+pytest
+```
+
+Run the app with `meshright` and open http://127.0.0.1:8765.
+
+To build the one-file app for your own computer:
+
+```bash
+pip install pyinstaller
+packaging/build.sh          # the app appears in dist/
+```
+
+## How the code is laid out
+
+| Path | What it is |
+| --- | --- |
+| `src/meshright/analysis.py` | Loads meshes, finds problems, computes the score |
+| `src/meshright/formats.py` | Extra file readers and unit/orientation fixes per format |
+| `src/meshright/actions.py` | Every change MeshRight can make, as named actions with checked inputs |
+| `src/meshright/document.py` | An open model and its undo history |
+| `src/meshright/server.py` | Local web server and API, including protection against other websites |
+| `src/meshright/cli.py` | The `meshright` command |
+| `src/meshright/web/` | Browser app (plain HTML, CSS and JavaScript, no build step) |
+| `src/meshright/web/vendor/` | Bundled three.js, so the app works offline |
+| `tests/` | Tests. Test meshes are generated in code |
+
+## Guidelines
+
+- **Beginners first.** Every message a user sees should make sense to someone
+  who has never heard the word "manifold". Say what is wrong and why it matters
+  for printing.
+- **No settings unless they are unavoidable.** Good defaults beat options.
+- **Local and offline.** Nothing may send a user's files or data to a remote
+  service. Optional online features must be opt-in and bring-your-own-key.
+- **Never commit secrets or personal data.** No API keys, tokens, passwords,
+  email addresses or personal file paths in code, tests, issues or commits.
+  Keep local settings in a `.env` file; it is ignored by git.
+- **Every change is an action.** New tools go in `actions.py` with a clear
+  title, description and checked inputs, and return a plain-English receipt.
+  The buttons, batch mode and the optional AI assistant all use this list.
+- **Add a test** for every new check or repair. Build the test mesh in code
+  (see `tests/conftest.py`) rather than adding binary files.
+- **Keep pull requests small** and focused on one thing.
+
+## Licence
+
+By contributing you agree that your work is released under the
+[GNU GPL v3](LICENSE), the same licence as the rest of the project.