Standard Python repository layout

Author: rdoursenaud

.github/workflows/pylint.yml

@@ -17,8 +17,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install pylint
-        cd src
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
     - name: Analysing the code with pylint
       run: |
-        pylint --output-format=colorized --disable=C0301,C0103 --fail-under=7.75 src
+        pylint --output-format=colorized --disable=C0301,C0103 --fail-under=7.75 python_mcu

.github/workflows/python-app.yml

@@ -22,7 +22,6 @@ jobs:
         python-version: 3.9
     - name: Install dependencies
       run: |
-        cd src
         python -m pip install --upgrade pip
         pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi

TODO.md

@@ -2,6 +2,7 @@
 - [x] [rdoursenaud] port to python 3 and pyside 2
 - [x] [rdoursenaud] cleanup code and make it PEP008 compliant
 - [x] [rdoursenaud] port latex documentation to Sphinx
+- [x] [rdoursenaud] standard Python repository layout
 - [ ] [rdoursenaud] write pytest unit tests only looking at the protocol docs
 - [ ] [rdoursenaud] properly handle invalid config file
 - [ ] [rdoursenaud] disallow start if MIDI ports are not set in the GUI
@@ -12,6 +13,7 @@
 - [ ] [rdoursenaud] explore if using mido could be beneficial
 - [ ] [rdoursenaud] add a nice icon
 - [ ] [rdoursenaud] reduce and restore from systray using QSystemTrayIcon or pystray
+- [ ] [rdoursenaud] add setup.py
 - [ ] [rdoursenaud] create Microsoft Windows binary using pyinstaller?
 - [x] [rdoursenaud] update documentation
 - [ ] [rdoursenaud] publish documentation to readthedocs.org

docs/conf.py

@@ -12,7 +12,7 @@
 #
 import sys
 
-sys.path.insert(0, '../src')
+sys.path.insert(0, '../python_mcu')
 
 # -- Project information -----------------------------------------------------
 

docs/license.rst

@@ -1,3 +1,5 @@
+.. _License:
+
 License
 =======