references

Here are various guides, tools, etc. that have been helpful to us while building Note Splitter.

misc

• Python documentation

• getting started with Git and GitHub

• PyYAML

user interface

• PySide6 (a.k.a. Qt for Python)

• PySide6 widgets

formatting, typing, and style

• pre-commit

• Black

• mypy

• flake8

• PEP 8

project structure

• BeeWare Briefcase

• Structuring Your Project — The Hitchhiker’s Guide to Python by Kenneth Reitz & Real Python

• Python import: Advanced Techniques and Tips by Real Python

• python packaging: basic setup.py and declarative metadata (intermediate) by AnthonyWritesCode

testing

• Automated Testing in Python with pytest, tox, and GitHub Actions by mCoding

• pytest

• tox

• coverage.py

documentation

• Documenting Python Code: A Complete Guide by Real Python

• Style guide — numpydoc Manual

• Sphinx

• MyST

• our notes on setting up documentation on Read The Docs

design patterns

• Python Design Patterns by Brandon Rhodes

• The Catalog of Design Patterns by Refactoring Guru

parsing

• intro to regex

• Introduction to Abstract Syntax Trees by Twilio

• Lexical analysis by Wikipedia

• Scanning by Crafting Interpreters