Merge pull request #23 from fronzbot/dev

1.0.0.b0

Author: fronzbot

.coveragerc

@@ -0,0 +1,4 @@
+[run]
+parallel = true
+omit =
+    tests/*

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: fronzbot
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Ubuntu]
+ - Version [e.g. 22]
+ - Python Version [e.g. 3.10]
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/lint.yml

@@ -11,23 +11,31 @@ on:
 
 jobs:
   lint:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         python-version: [3.9]
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install GTK
+      run: |
+        sudo apt-get update
+        sudo apt-get install build-essential libgtk-3-dev
+    - name: Install wxPython
       run: |
         python -m pip install --upgrade pip
+        pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-22.04 wxPython --user
+    - name: Install Dependencies
+      run: |
         pip install -r requirements.txt
         pip install -r requirements_test.txt
-        pip install tox
     - name: Lint
       run: |
-        tox -r -e lint
+        ruff check waferview tests
+        black --check --diff waferview tests
+        rst-lint README.rst

.github/workflows/publish.yml

@@ -13,11 +13,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python
       uses: actions/setup-python@v4
       with:
-        python-version: '3.9'
+        python-version: '3.11'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

.github/workflows/test.yml

@@ -8,26 +8,53 @@ on:
 
 jobs:
   build:
-    runs-on: ${{ matrix.platform }}
+    runs-on: ${{ matrix.os }}
     strategy:
       max-parallel: 4
+      fail-fast: false
       matrix:
-        platform:
-          - ubuntu-latest
-        python-version: ['3.8', '3.9', '3.10', '3.11']
-
+        include:
+          - os: ubuntu-22.04
+            python-version: '3.9'
+            download-wheel: true
+          - os: ubuntu-22.04
+            python-version: '3.10'
+            download-wheel: true
+          - os: ubuntu-22.04
+            python-version: '3.11'
+            download-wheel: true
+          - os: ubuntu-20.04
+            python-version: '3.10'
+            download-wheel: true
+          - os: macos-latest
+            python-version: '3.11'
+          - os: windows-latest
+            python-version: '3.11'
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
+      with:
+        lfs: true
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Update Pip
       run: |
         python -m pip install --upgrade pip
+    - if: ${{ matrix.download-wheel }}
+      name: Install GTK
+      run: |
+        sudo apt-get update
+        sudo apt-get install build-essential libgtk-3-dev
+    - if: ${{ matrix.download-wheel }}
+      name: Install wxPython
+      run: |
+          pip install -U -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/${{ matrix.os }} wxPython --user
+    - name: Install Dependencies
+      run: |
         pip install -r requirements.txt
         pip install -r requirements_test.txt
         pip install tox
     - name: Tests
       run: |
-        tox -r
+        pytest --timeout=9 --durations=10 -cov=waferview --cov-report term-missing

.gitignore

@@ -25,6 +25,7 @@ share/python-wheels/
 .installed.cfg
 *.egg
 MANIFEST
+.DS_Store
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -50,6 +51,7 @@ coverage.xml
 .hypothesis/
 .pytest_cache/
 cover/
+.ruff_cache/
 
 # Translations
 *.mo

CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# Contributing to Wafer View
+
+Everybody is invited and welcome to contribute to Wafer View.
+
+The process is straight-forward.
+
+ - Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1)
+ - Fork Wafer View [git repository](https://github.com/fronzbot/wafer-view).
+ - Write the code for your feature/improvement/bug fix
+ - Ensure tests work.
+ - Create a Pull Request against the [**dev**](https://github.com/fronzbot/wafer-view/tree/dev) branch of Wafer View.
+
+## Feature suggestions
+
+If you want to suggest a new feature for Home Assistant (e.g., new integrations), please open a thread in our [Community Forum: Feature Requests](https://community.home-assistant.io/c/feature-requests).
+We use [GitHub for tracking issues](https://github.com/home-assistant/core/issues), not for tracking feature requests.
+
+## Development Quick-Start
+
+#### Setup Local Repository
+
+```bash
+git clone git@github.com:<github-username>/wafer-view.git
+cd wafer-view
+git remote add upstream https://github.com/fronzbot/wafer-view.git
+```
+
+#### Create a virtualenv and install dependencies
+
+First: if on linux, it's possible you need to install GTK3 for the GUI to work. Run the following commands (commands shown for debian):
+
+```bash
+sudo apt-get update
+sudo apt-get install build-essential libgtk-3-dev
+```
+
+```bash
+python -m venv venv
+source venv/bin/activate
+pip install -r requirement.txt
+pip install -r requirements_test.txt
+pip install tox
+pip install -e .
+```
+
+#### Create your feature branch
+
+```bash
+git checkout -b <branch-name>
+```
+
+#### Make changes
+
+Now you can make changes to your code. Keep changes minimal (ie. if you're working on adding a new standard, don't also include GUI changes- make those separate PR's even if they're linked)
+
+#### Test changes
+
+To run all tests:
+
+```bash
+tox
+```
+
+On Debian, it can take a long time to install wxPython inside the tox venv. As such, here are the commands you can use that do not rely on tox:
+
+For linting: 
+```bash
+ruff check waferview tests
+black --check --diff waferview tests
+rst-lint README.rst
+```
+
+For tests:
+```bash
+pytest --timeout=9 --durations=10 -cov=waferview --cov-report term-missing
+```
+
+For new features, please add tests to ensure the feature works as intended and that any future changes do not break the intended behavior.
+
+#### Commit Changes
+
+```bash
+git add .
+git commit
+```
+
+#### Catching up with dev
+
+If your code is taking a while to develop, you may be behind the `dev` branch, in which case you need to catch up before creating your pull-request. To do this you can run `git rebase` as follows (running this on your local branch):
+
+```bash
+git fetch upstream dev
+git rebase upstream/dev
+```
+
+If rebase detects conflicts, repeat the following process until all changes have been resolved:
+
+1. git status shows you the filw with a conflict. You will need to edit that file and resolve the lines between `<<<< | >>>>`
+2. Add the modified file: `git add <file>` or `git add .`
+3. Continue rebase: `git rebase --continue`
+4. Repeat until all conflicts resolved
+
+#### Push and Submit PR
+
+Once you're ready to submit your PR, go ahead and push your changes to your fork:
+
+```bash
+git push origin <branch-name>
+```
+1. On GitHub, navigate to the [wafer-view](https://github.com/fronzbot/wafer-view/tree/dev) repository.
+2. In the "Branch" menu, choose the branch that contains your commits (from your fork).
+3. To the right of the Branch menu, click New pull request.
+4. The base branch dropdown menu should read `dev`. Use the compare branch drop-down menu to choose the branch you made your changes in.
+5. Type a title and complete the provided description for your pull request.
+6. Click Create pull request.
+7. 
+More detailed instructions can be found here: [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request)

README.rst

@@ -1,7 +1,57 @@
 wafer-view |Build Status| |PyPi Version|
 =======================================================
 
-Wafer map viewer for semi.org xml standards written in Python
+Wafer map viewer for semi.org XML standards written in Python
+
+Summary
+--------
+
+The Wafer-View utility allows a generic XML wafermap file to be viewed. The tool parses the XML and generates bitmap images corresponding to the die status as defined in the wafermap XML file. Each die status can be individually enabled or disabled as well as their colors modified, to easily distinguish where on the wafer any failures occur. Total die, pass/fail, and yield results are also calculated and reported.
+
+.. figure:: wafer_map.png
+    :alt: wafer map
+    
+    wafermap
+
+
+Installation
+--------------
+
+Pre-Requisites
+```````````````
+
+If you are running MacOS or Windows, please skip this section.
+For linux systems, you may need to install GTK. This is done as follows (using Debian commands as an example):
+
+.. code-block::
+
+   sudo apt-get update
+   sudo apt-get install build-essential libgtk-3-dev
+
+From PyPi (Preferred)
+``````````````````````
+
+.. code-block::
+
+   pip install wafer-view
+
+From Github
+`````````````
+
+Clone the github repository and install
+
+.. code-block::
+
+    git clone https://github.com/fronzbot/wafer-view.git
+    cd wafer\-view
+    git checkout main
+    pip install .
+
+Usage
+------
+
+Once installed, running the command `waferview` will open up the Wafer View GUI. Using the File menu, an xml wafermap can be loaded and viewed. Each bin can be independantly enabled/disabled and the color scheme can be changed on the fly to easily find where failures occur on a die. The wafer image can also be saved as a bitmap.
+
 
 .. |Build Status| image:: https://github.com/fronzbot/wafer-view/workflows/build/badge.svg
    :target: https://github.com/fronzbot/wafer-view/actions?query=workflow%3Abuild

pyproject.toml

@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "wafer-view"
-version = "1.0.0-alpha"
-license = "Apache-2.0"
+version = "1.0.0-beta"
+license = {file = "LICENSE"}
 description = "An open source semi.org xml wafer viewer"
 readme = "README.rst"
 authors = [
-    {name = "Kevin Fronczak", email = "kfronczak@gmail.com"},
+    {name = "Kevin Fronczak", email = "kfronczak@gmail.com"}
 ]
 maintainers = [
     {name = "Kevin Fronczak", email = "kfronczak@gmail.com"},
@@ -26,6 +26,9 @@ classifiers = [
 requires-python = ">=3.8.0"
 dynamic = ["dependencies"]
 
+[project.scripts]
+waferview = "waferview:__main__"
+
 [tool.setuptools.dynamic]
 dependencies = {file = ["requirements.txt"]}
 
@@ -87,7 +90,7 @@ ignore = [
 
 line-length = 88
 
-target-version = "py39"
+target-version = "py311"
 
 [tool.ruff.per-file-ignores]
 

requirements.txt

@@ -0,0 +1,2 @@
+xmltodict==0.13.0
+wxPython==4.2.1