SLASD 0.0.0__tar.gz

slasd-0.0.0/.arduino_config.lua

@@ -0,0 +1,5 @@
+return {
+    board = "arduino:avr:mega",
+    port = "/dev/ttyUSB0",
+    baudrate = "115200",
+}

slasd-0.0.0/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = false
+end_of_line = lf
+indent_style = space
+indent_size = 4
+max_line_length = 100

slasd-0.0.0/.github/ISSUE_TEMPLATE/1-spelling.yml

@@ -0,0 +1,35 @@
+name: 🖋️ Spelling and Grammar
+description: Template for Spelling and Grammar reports
+title: "[🖋️]"
+body:
+    - type: checkboxes
+      id: check-search
+      attributes:
+          label: Is there an existing issue for this?
+          description: >-
+              Please search to see if an issue already exists for the issue you encountered.
+          options:
+              - label: I have searched the existing issues
+                required: true
+    - type: textarea
+      id: location
+      attributes:
+          label: Where are the errors?
+          description: The location where the error can be found
+          placeholder: "Example: Page x of pdf y or path to a file in the repository."
+      validations:
+          required: true
+    - type: textarea
+      id: whats-wrong
+      attributes:
+          label: What's is the error?
+          description: A description of the error
+          placeholder: "Example: You spelled grammar as grammer. "
+      validations:
+          required: true
+    - type: textarea
+      id: solution
+      attributes:
+          label: "Proposed solution:"
+          description: A description of how to resolve the error
+          placeholder: "Example: Change grammer -> grammar"

slasd-0.0.0/.github/ISSUE_TEMPLATE/2-clarity.yml

@@ -0,0 +1,37 @@
+name: 🤷 Clarity
+description: Template for clarity reports
+title: '[🤷]'
+body:
+  - type: checkboxes
+    id: check-search
+    attributes:
+      label: Is there an existing issue for this?
+      description: >-
+        Please search to see if an issue already exists for the issue you
+        encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    id: location
+    attributes:
+      label: Where are the errors?
+      description: The location where the error can be found
+      placeholder: 'Example: Page x of pdf y or path to a file in the repository.'
+    validations:
+      required: true
+  - type: textarea
+    id: whats-wrong
+    attributes:
+      label: What's is the error?
+      description: A description of the error
+      placeholder: 'Example: I think where you say x you mean y. '
+    validations:
+      required: true
+  - type: textarea
+    id: solution
+    attributes:
+      label: 'Proposed solution:'
+      description: A description of how to resolve the error
+      placeholder: 'Example: Reword x like z so that it better reflects y.'
+

slasd-0.0.0/.github/ISSUE_TEMPLATE/3-question.yml

@@ -0,0 +1,25 @@
+name: ❓ Question
+description: Template for asking questions
+title: "[❓] "
+labels:
+  - Question
+body:
+  - type: checkboxes
+    id: check-search
+    attributes:
+      label: Is there an existing issue for this?
+      description: >-
+        Please search to see if an issue already exists for the issue you
+        encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: textarea
+    id: whats-your-question
+    attributes:
+      label: What is the your question?
+      description: Your question
+      placeholder: >-
+        Example: How do you know xyz is true?
+    validations:
+      required: true

slasd-0.0.0/.github/ISSUE_TEMPLATE/4-bug.yml

@@ -0,0 +1,72 @@
+name: 🐞 Bug
+description: File a bug report issue
+title: '[🐞] '
+labels:
+  - Bug
+  - Needs Triage
+body:
+  - type: checkboxes
+    id: check-search
+    attributes:
+      label: Is there an existing issue for this?
+      description: >-
+        Please search to see if an issue already exists for the bug you
+        encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+  - type: checkboxes
+    id: check-version
+    attributes:
+      label: Are you using the latest version of the libraries?
+      description: >-
+        Only bug reports that can be reproduced on the latest release will be
+        considered.
+      options:
+        - label: I have confirmed I'm using the latest version of the libraries
+          required: true
+  - type: textarea
+    attributes:
+      label: Environment
+      description: >-
+        examples:  - **OS**: Windows 11 22H2  - **Compiler:**: clang   -
+        **Compiler Version:**: 7.0.0    - **Libraries Impacted**:  x,y,z
+      value: |-
+        - OS: 
+        - Compiler:
+        - Compiler Version:   
+        - Libraries Impacted:
+      render: Markdown
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: |
+        A clear and concise description of what the bug is.
+        If applicable, add screenshots and log to help explain your problem.
+    validations:
+      required: true
+  - type: textarea
+    id: debug-output
+    attributes:
+      label: Debug Output
+      description: |
+        Steps to get debug output:
+        1. Do x
+        2. Do y
+        3. Do z
+        5. Upload the debug output here
+    validations:
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Anything else?
+      description: >
+        Links? References? Anything that will give us more context about the
+        issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to
+        highlight it and then dragging files in.

slasd-0.0.0/.github/ISSUE_TEMPLATE/5-enhancement.yml

@@ -0,0 +1,34 @@
+name: 🚀 Enhancement
+description: Template for suggesting and enhancement
+title: "[🚀] "
+labels:
+    - Enhancement
+body:
+    - type: checkboxes
+      id: check-search
+      attributes:
+          label: Is there an existing issue for this?
+          description: >-
+              Please search to see if an issue already exists for the issue you
+              encountered.
+          options:
+              - label: I have searched the existing issues
+                required: true
+    - type: checkboxes
+      id: check-pull
+      attributes:
+          label: Will you be opening a pull request?
+          description: >-
+              Will you be opening a pull request for this enhancement?
+          options:
+              - label: "yes"
+              - label: "no"
+    - type: textarea
+      id: whats-your-suggestion
+      attributes:
+          label: What is the your suggested enhancement? and Why is it an enhancement?
+          description: Your question
+          placeholder: >-
+              Example: You should add xyz feature to this work.
+      validations:
+          required: true

slasd-0.0.0/.github/PULL_REQUEST_TEMPLATE/001-change_set.md

@@ -0,0 +1,50 @@
+Please set the title of the pull request to:
+
+```text
+[📑] <title>
+```
+
+[Provide a succinct and descriptive title for the pull request, e.g., "Implements a new notation
+module for the Conway notation."]
+
+## Type of Change
+
+- [ ] New feature
+- [ ] Bug fix
+- [ ] Documentation update
+- [ ] Refactoring
+
+## Description
+
+[Provide a detailed explanation of the changes you have made. Include the reasons behind these
+changes and any relevant context. Link any related issues.]
+
+## Testing
+
+[Detail the testing you have performed to ensure that these changes function as intended. Include
+information about any added tests.]
+
+## Additional Information
+
+[Any additional information that reviewers should be aware of.]
+
+## Checklist
+
+[Provide a justification for any unchecked boxes.]
+
+- [ ] I have made corresponding changes to the documentation.
+- [ ] There is no `./.todo` directory
+- [ ] My code adheres to the coding and style guidelines of the project.
+- [ ] I have performed a self-review of my own code.
+- [ ] I have commented my code, particularly in hard-to-understand areas.
+- [ ] My changes generate no new errors or warnings
+- [ ] No new tests are failing.
+
+### New Feature List
+
+[Provide a justification for any unchecked boxes.]
+
+- [ ] The feature has a use case document
+- [ ] The feature has a unit description document
+- [ ] The feature has an implementation
+- [ ] The feature has unit tests

slasd-0.0.0/.github/PULL_REQUEST_TEMPLATE/002-madr.md

@@ -0,0 +1,20 @@
+Please set the title of the pull request to:
+
+```text
+[💭] <madr title>
+```
+
+> [!note]
+>
+> 1. Create a branch for a proposal with the name: proposal-{{short title}}
+> 2. Create a pull request with this template.
+> 3. In the branch create a Markdown file based on the [MADR Template](https://github.com/adr/madr/blob/4.0.0/template/adr-template.md).
+>    Name the Markdown file:
+>       {{issue# padded to five digits}}-{{title}}
+> 4. When a decision is made change the status to:
+>     * "accepted" and pull the branch into main branch
+>     * "rejected" and pull the branch into main branch
+
+[link to rendered proposal (branch)](<link to file on proposal branch>)
+
+[link to rendered proposal (main)](<link to file on main>)

slasd-0.0.0/.github/pull_request_template.md

@@ -0,0 +1,5 @@
+
+Please go to the `Preview` tab and select the appropriate sub-template:
+
+* [📑 Change Set](?quick_pull=1&expand=1&template=001-change_set.md)
+* [💭 MADR](?quick_pull=1&expand=1&template=002-madr.md)

slasd-0.0.0/.github/workflows/flake.yml

@@ -0,0 +1,23 @@
+name: update-flake-lock
+on:
+    workflow_dispatch: # allows manual triggering
+    schedule:
+        - cron: "0 0 * * 0" # runs weekly on Sunday at 00:00
+
+jobs:
+    lockfile:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
+            - name: Update flake.lock
+              uses: DeterminateSystems/update-flake-lock@main
+              with:
+                  pr-title: "[❄️] Update flake.lock" # Title of PR to be created
+                  commit-msg: "CHORE: Bump flake.lock"
+                  pr-labels: |
+                      dependencies
+                      automated
+                  token: ${{ secrets.GH_TOKEN_FOR_UPDATES }}

slasd-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,103 @@
+name: Do quality check and release
+
+on:
+    pull_request:
+        branches: ["main"]
+
+    workflow_dispatch:
+        inputs:
+            branch:
+                description: "Branch to release"
+                required: true
+                type: choice
+                default: main
+                options:
+                    - main
+                    # You can add more options here if you need to test on different SDK versions
+            do_release:
+                description: 'Create Release (must also select Tag above!")'
+                required: true
+                default: false
+                type: boolean
+
+            do_page:
+                description: "Publish to github pages"
+                required: true
+                default: false
+                type: boolean
+
+permissions:
+    pages: write
+    id-token: write
+    contents: write
+
+jobs:
+    release:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+                  fetch-depth: 0
+
+            - name: Check Nixpkgs inputs
+              uses: DeterminateSystems/flake-checker-action@main
+              with:
+                  fail-mode: true
+
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
+
+            - name: Check
+              run: |
+                  nix develop --command \
+                      just check-release
+
+            - name: Docs html
+              run: |
+                  nix develop --command \
+                    just html
+
+            - name: Upload artifact
+              if: inputs.do_page
+              uses: actions/upload-pages-artifact@v5
+              with:
+                  path: ./.build/docs
+
+            - name: Deploy to GitHub Pages
+              if: inputs.do_page
+              uses: actions/deploy-pages@v5
+
+            - name: Release
+              if: startsWith(github.ref, 'refs/tags/') && inputs.do_release
+              uses: softprops/action-gh-release@v2
+
+    publish:
+        if: startsWith(github.ref, 'refs/tags/') && inputs.do_release
+        needs: release
+        environment:
+            name: pypi
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  submodules: recursive
+                  fetch-depth: 0
+
+            - name: Check Nixpkgs inputs
+              uses: DeterminateSystems/flake-checker-action@main
+              with:
+                  fail-mode: true
+
+            - name: Install Nix
+              uses: DeterminateSystems/nix-installer-action@main
+            - name: Build
+              run: |
+                  nix develop --command \
+                   uv build
+
+            # Check that basic features work and we didn't miss to include crucial files
+            - name: Publish
+              run: |
+                  nix develop --command \
+                   uv publish

slasd-0.0.0/.gitignore

@@ -0,0 +1,227 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+.direnv
+.envrc
+.emcache
+*.orig
+out.*
+.todo/

slasd-0.0.0/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+    - repo: local
+      hooks:
+          - id: ruff_check
+            name: ruff check
+            language: system
+            entry: ruff check
+            exclude:
+                glob:
+                    - "libraries/**/*.*"
+            files:
+                glob:
+                    - "fastrakSerialDriver/**/*.py"
+
+          - id: ruff_format
+            name: ruff format
+            language: system
+            entry: ruff format --check
+            exclude:
+                glob:
+                    - "libraries/**/*.*"
+            files:
+                glob:
+                    - "fastrakSerialDriver/**/*.py"
+          - id: tombi
+            name: tombi
+            language: system
+            entry: tombi format --check
+            exclude:
+                glob:
+                    - ".github/**/*.*"
+            files:
+                glob:
+                    - "**/*.toml"
+          - id: docs
+            name: docs
+            language: system
+            entry: rumdl check
+            exclude:
+                glob:
+                    - ".github/**/*.*"
+            files:
+                glob:
+                    - "**/*.md"