Version 1.0.0

Co-authored-by: mdmedley <[email protected]>

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+* @bbrown1867
+* @mdmedley

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,33 @@
+# Contributing
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Individual Contributor License Agreement
+
+Before your code can be accepted into the project you must also sign the
+[Individual Contributor License Agreement (CLA)](https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1).
+
+## Bug Reports
+
+A good bug report involves a demonstrable problem in the existing code with steps to reproduce it. In general, include the following:
+
+- What was your environment?
+- What was the expected behaviour vs. what was the actual behaviour?
+- Steps to reproduce.
+- Any other information you feel is relevant.
+
+## Feature Requests
+
+Feature requests are always welcome, but please detail your feature request in full, and explain how it would fit into the current project.
+
+## Pull Requests
+
+Pull requests are always welcome, but please open an issue before embarking on any significant pull request.
+
+## Coding Conventions
+
+- Add unit test coverage for new code.
+- If your changes involve a new hardware platform, please consider adding it to the `examples/` directory.
+- Pre-commit hooks and continuous integration will ensure the project coding style is followed when making changes.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+_Please explain the changes you made here._
+
+_Does this close any currently open issues?_
+
+_Checklist:_
+
+- [ ] [Individual Contributor License Agreement (CLA)](https://spreadsheets.google.com/spreadsheet/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1) signed

.github/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+Square recognizes the important contributions the security research community can make. We therefore encourage reporting security issues with the code contained in this repository.
+
+If you believe you have discovered a security vulnerability, please follow the guidelines at [https://bugcrowd.com/squareopensource](https://bugcrowd.com/squareopensource)

.github/workflows/publish.yml

@@ -0,0 +1,23 @@
+name: Publish
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+      - name: Build
+        run: make wheel
+      - name: Publish
+        uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages_dir: ./dist/

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest ]
+        python-version: [ 3.7, 3.8, 3.9 ]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version}}
+      - name: Setup
+        run: make setup
+      - name: Lint
+        run: .venv/bin/pre-commit run pylint -v
+      - name: Style
+        run: .venv/bin/pre-commit run black -v
+      - name: Typing
+        run: .venv/bin/pre-commit run mypy -v
+      - name: Wheel
+        run: make wheel
+      - name: Test
+        run: make test

.gitignore

@@ -0,0 +1,9 @@
+*.pyc
+.coverage
+.venv/
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+**/__pycache__/
+**/target/

.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        entry: .venv/bin/black pyfu_usb/ tests/ setup.py
+        language: system
+        args: ["--check"]
+        pass_filenames: false
+        always_run: true
+      - id: mypy
+        name: mypy
+        entry: .venv/bin/mypy pyfu_usb/ tests/
+        language: system
+        pass_filenames: false
+        always_run: true
+      - id: pylint
+        name: pylint
+        entry: .venv/bin/pylint pyfu_usb/ tests/ setup.py
+        language: system
+        pass_filenames: false
+        always_run: true
+      - id: isort
+        name: isort
+        entry: .venv/bin/isort pyfu_usb/ tests/ setup.py
+        language: system
+        pass_filenames: false
+        always_run: true

.python-version

@@ -0,0 +1 @@
+3.7.13

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2022-06-09
+
+- Initial release.

LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2013-2021 Ibrahim Abdelkader <[email protected]>
+Copyright (c) 2013-2021 Kwabena W. Agyeman <[email protected]>
+Copyright (c) 2022 Block Inc.
+
+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

Makefile

@@ -0,0 +1,33 @@
+VENV_DIR := .venv
+VENV_PYTHON := $(VENV_DIR)/bin/python
+
+$(VENV_DIR):
+	@echo "Setting up virtual environment and pre-commit hooks..."
+	@python -m venv $@
+	@$(VENV_PYTHON) -m pip install --upgrade --quiet pip -i https://pypi.python.org/simple
+	@$(VENV_PYTHON) -m pip install --upgrade --quiet --editable ".[dev]" -i https://pypi.python.org/simple
+	@$(VENV_PYTHON) -m pre_commit install --install-hooks
+	@echo "Setup complete."
+
+.PHONY: setup
+setup: | $(VENV_DIR)
+
+.PHONY: pre_commit
+pre_commit: | $(VENV_DIR)
+	@export PATH=$(VENV_DIR)/bin:$$PATH; $(VENV_PYTHON) -m pre_commit run --all-files
+
+.PHONY: test
+test: | $(VENV_DIR)
+	$(VENV_DIR)/bin/coverage run $(VENV_DIR)/bin/pytest -s --log-cli-level=INFO tests/
+
+.PHONY: coverage
+coverage: test
+	$(VENV_DIR)/bin/coverage report
+
+.PHONY: wheel
+wheel: | $(VENV_DIR)
+	$(VENV_PYTHON) setup.py bdist_wheel
+
+.PHONY: clean
+clean:
+	@rm -rf $(VENV_DIR) *.egg-info/ dist/ build/ .pytest_cache/